em-toolhub

REST API for customer access to ToolHub well data.

Authentication

All endpoints require Bearer token authentication using an API key:

Authorization: Bearer thub_live_xxxxxxxxxxxxxxxxxxxx

API keys are issued per-organization and inherit well access permissions.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.2.0
• Package version: 0.2.0
• Generator version: 7.22.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://erdosmiller.com

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/Erdos-Miller/repo.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/Erdos-Miller/repo.git)

Then import the package:

import em_toolhub

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import em_toolhub

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import em_toolhub
from em_toolhub.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.erdosmiller.com
# See configuration.py for a list of all supported configuration parameters.
configuration = em_toolhub.Configuration(
    host = "https://api.erdosmiller.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Key): bearerAuth
configuration = em_toolhub.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with em_toolhub.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = em_toolhub.WellboresApi(api_client)
    well_id = 'well_id_example' # str | 
    create_wellbore_request_body = em_toolhub.CreateWellboreRequestBody() # CreateWellboreRequestBody |  (optional)

    try:
        # Create wellbore
        api_response = api_instance.create_wellbore(well_id, create_wellbore_request_body=create_wellbore_request_body)
        print("The response of WellboresApi->create_wellbore:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WellboresApi->create_wellbore: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.erdosmiller.com

Documentation For Models

• CreateWellbore201ResponseBody
• CreateWellbore201ResponseBodyData
• CreateWellbore201ResponseBodyMeta
• CreateWellbore400ResponseBody
• CreateWellbore400ResponseBodyError
• CreateWellbore401ResponseBody
• CreateWellbore500ResponseBody
• CreateWellboreRequestBody
• DeleteWellbore200ResponseBody
• DeleteWellbore200ResponseBodyData
• DeleteWellbore400ResponseBody
• DeleteWellbore401ResponseBody
• DeleteWellbore404ResponseBody
• DeleteWellbore500ResponseBody
• ErrorMessage
• GetWellbore200ResponseBody
• GetWellbore401ResponseBody
• GetWellbore404ResponseBody
• GetWellbore500ResponseBody
• GetWellboreTree200ResponseBody
• GetWellboreTree200ResponseBodyData
• GetWellboreTree200ResponseBodyDataTreeInner
• GetWellboreTree200ResponseBodyDataTreeInnerChildrenInner
• GetWellboreTree200ResponseBodyDataTreeInnerChildrenInnerChildrenInner
• GetWellboreTree200ResponseBodyDataTreeInnerChildrenInnerChildrenInnerChildrenInner
• GetWellboreTree401ResponseBody
• GetWellboreTree500ResponseBody
• ListWellbores200ResponseBody
• ListWellbores200ResponseBodyData
• ListWellbores401ResponseBody
• ListWellbores404ResponseBody
• ListWellbores500ResponseBody
• UpdateWellbore200ResponseBody
• UpdateWellbore400ResponseBody
• UpdateWellbore401ResponseBody
• UpdateWellbore404ResponseBody
• UpdateWellbore500ResponseBody
• UpdateWellboreRequestBody

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (API Key)

Author