em-toolhub 0.1.0

ToolHub Customer API

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.

Rate Limits

• Standard tier: 70 requests/minute
• Premium tier: 300 requests/minute

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

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

Requirements.

Python 3.9+

Installation & Usage

pip install

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

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.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 http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = em_toolhub.Configuration(
    host = "http://localhost"
)

# 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.FilesApi(api_client)
    well_id = 'well_id_example' # str | 
    file_id = 'file_id_example' # str | 

    try:
        # Delete a file
        api_response = api_instance.delete_file(well_id, file_id)
        print("The response of FilesApi->delete_file:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FilesApi->delete_file: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
FilesApi	delete_file	DELETE /api/v1/wells/{wellId}/files/{fileId}	Delete a file
FilesApi	download_file	GET /api/v1/wells/{wellId}/files/{fileId}/download	Download a file
FilesApi	get_file	GET /api/v1/wells/{wellId}/files/{fileId}	Get file metadata
FilesApi	list_files	GET /api/v1/wells/{wellId}/files	List files
SurveysApi	get_survey	GET /api/v1/wells/{wellId}/surveys/{surveyId}	Get survey details
SurveysApi	list_surveys	GET /api/v1/wells/{wellId}/surveys	List surveys for a well
WellsApi	get_well	GET /api/v1/wells/{wellId}	Get well details
WellsApi	list_wells	GET /api/v1/wells	List wells

Documentation For Models

• DeleteFile401ResponseBody
• DeleteFile401ResponseBodyError
• DeleteFile401ResponseBodyMeta
• DeleteFile404ResponseBody
• DeleteFile500ResponseBody
• DownloadFile401ResponseBody
• DownloadFile404ResponseBody
• DownloadFile500ResponseBody
• ErrorMessage
• GetFile200ResponseBody
• GetFile200ResponseBodyData
• GetFile401ResponseBody
• GetFile404ResponseBody
• GetFile500ResponseBody
• GetSurvey200ResponseBody
• GetSurvey200ResponseBodyData
• GetSurvey200ResponseBodyDataCorrectionsInner
• GetSurvey200ResponseBodyDataRaw
• GetSurvey401ResponseBody
• GetSurvey404ResponseBody
• GetSurvey500ResponseBody
• GetWell200ResponseBody
• GetWell200ResponseBodyData
• GetWell200ResponseBodyDataWellboresInner
• GetWell401ResponseBody
• GetWell404ResponseBody
• GetWell500ResponseBody
• ListFiles200ResponseBody
• ListFiles200ResponseBodyData
• ListFiles200ResponseBodyDataFilesInner
• ListFiles401ResponseBody
• ListFiles404ResponseBody
• ListFiles500ResponseBody
• ListSurveys200ResponseBody
• ListSurveys200ResponseBodyData
• ListSurveys200ResponseBodyDataSurveysInner
• ListSurveys401ResponseBody
• ListSurveys404ResponseBody
• ListSurveys500ResponseBody
• ListWells200ResponseBody
• ListWells200ResponseBodyData
• ListWells200ResponseBodyDataWellsInner
• ListWells401ResponseBody
• ListWells500ResponseBody

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (API Key)

Author