em-toolhub 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- em_toolhub-0.1.0/PKG-INFO +204 -0
- em_toolhub-0.1.0/README.md +187 -0
- em_toolhub-0.1.0/em_toolhub/__init__.py +140 -0
- em_toolhub-0.1.0/em_toolhub/api/__init__.py +7 -0
- em_toolhub-0.1.0/em_toolhub/api/files_api.py +1232 -0
- em_toolhub-0.1.0/em_toolhub/api/surveys_api.py +696 -0
- em_toolhub-0.1.0/em_toolhub/api/wells_api.py +612 -0
- em_toolhub-0.1.0/em_toolhub/api_client.py +804 -0
- em_toolhub-0.1.0/em_toolhub/api_response.py +21 -0
- em_toolhub-0.1.0/em_toolhub/configuration.py +592 -0
- em_toolhub-0.1.0/em_toolhub/exceptions.py +219 -0
- em_toolhub-0.1.0/em_toolhub/models/__init__.py +60 -0
- em_toolhub-0.1.0/em_toolhub/models/delete_file401_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/delete_file401_response_body_error.py +89 -0
- em_toolhub-0.1.0/em_toolhub/models/delete_file401_response_body_meta.py +89 -0
- em_toolhub-0.1.0/em_toolhub/models/delete_file404_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/delete_file500_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/download_file401_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/download_file404_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/download_file500_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/error_message.py +87 -0
- em_toolhub-0.1.0/em_toolhub/models/get_file200_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/get_file200_response_body_data.py +115 -0
- em_toolhub-0.1.0/em_toolhub/models/get_file401_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/get_file404_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/get_file500_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/get_survey200_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/get_survey200_response_body_data.py +178 -0
- em_toolhub-0.1.0/em_toolhub/models/get_survey200_response_body_data_corrections_inner.py +95 -0
- em_toolhub-0.1.0/em_toolhub/models/get_survey200_response_body_data_raw.py +155 -0
- em_toolhub-0.1.0/em_toolhub/models/get_survey401_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/get_survey404_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/get_survey500_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/get_well200_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/get_well200_response_body_data.py +136 -0
- em_toolhub-0.1.0/em_toolhub/models/get_well200_response_body_data_wellbores_inner.py +93 -0
- em_toolhub-0.1.0/em_toolhub/models/get_well401_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/get_well404_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/get_well500_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/list_files200_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/list_files200_response_body_data.py +101 -0
- em_toolhub-0.1.0/em_toolhub/models/list_files200_response_body_data_files_inner.py +113 -0
- em_toolhub-0.1.0/em_toolhub/models/list_files401_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/list_files404_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/list_files500_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/list_surveys200_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/list_surveys200_response_body_data.py +101 -0
- em_toolhub-0.1.0/em_toolhub/models/list_surveys200_response_body_data_surveys_inner.py +140 -0
- em_toolhub-0.1.0/em_toolhub/models/list_surveys401_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/list_surveys404_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/list_surveys500_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/list_wells200_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/list_wells200_response_body_data.py +101 -0
- em_toolhub-0.1.0/em_toolhub/models/list_wells200_response_body_data_wells_inner.py +126 -0
- em_toolhub-0.1.0/em_toolhub/models/list_wells401_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/models/list_wells500_response_body.py +97 -0
- em_toolhub-0.1.0/em_toolhub/py.typed +0 -0
- em_toolhub-0.1.0/em_toolhub/rest.py +263 -0
- em_toolhub-0.1.0/em_toolhub.egg-info/PKG-INFO +204 -0
- em_toolhub-0.1.0/em_toolhub.egg-info/SOURCES.txt +112 -0
- em_toolhub-0.1.0/em_toolhub.egg-info/dependency_links.txt +1 -0
- em_toolhub-0.1.0/em_toolhub.egg-info/requires.txt +4 -0
- em_toolhub-0.1.0/em_toolhub.egg-info/top_level.txt +1 -0
- em_toolhub-0.1.0/pyproject.toml +94 -0
- em_toolhub-0.1.0/setup.cfg +7 -0
- em_toolhub-0.1.0/setup.py +49 -0
- em_toolhub-0.1.0/test/test_delete_file401_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_delete_file401_response_body_error.py +54 -0
- em_toolhub-0.1.0/test/test_delete_file401_response_body_meta.py +54 -0
- em_toolhub-0.1.0/test/test_delete_file404_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_delete_file500_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_download_file401_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_download_file404_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_download_file500_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_error_message.py +51 -0
- em_toolhub-0.1.0/test/test_files_api.py +59 -0
- em_toolhub-0.1.0/test/test_get_file200_response_body.py +80 -0
- em_toolhub-0.1.0/test/test_get_file200_response_body_data.py +71 -0
- em_toolhub-0.1.0/test/test_get_file401_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_get_file404_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_get_file500_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_get_survey200_response_body.py +126 -0
- em_toolhub-0.1.0/test/test_get_survey200_response_body_data.py +99 -0
- em_toolhub-0.1.0/test/test_get_survey200_response_body_data_corrections_inner.py +60 -0
- em_toolhub-0.1.0/test/test_get_survey200_response_body_data_raw.py +70 -0
- em_toolhub-0.1.0/test/test_get_survey401_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_get_survey404_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_get_survey500_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_get_well200_response_body.py +88 -0
- em_toolhub-0.1.0/test/test_get_well200_response_body_data.py +80 -0
- em_toolhub-0.1.0/test/test_get_well200_response_body_data_wellbores_inner.py +58 -0
- em_toolhub-0.1.0/test/test_get_well401_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_get_well404_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_get_well500_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_list_files200_response_body.py +90 -0
- em_toolhub-0.1.0/test/test_list_files200_response_body_data.py +82 -0
- em_toolhub-0.1.0/test/test_list_files200_response_body_data_files_inner.py +70 -0
- em_toolhub-0.1.0/test/test_list_files401_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_list_files404_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_list_files500_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_list_surveys200_response_body.py +114 -0
- em_toolhub-0.1.0/test/test_list_surveys200_response_body_data.py +106 -0
- em_toolhub-0.1.0/test/test_list_surveys200_response_body_data_surveys_inner.py +83 -0
- em_toolhub-0.1.0/test/test_list_surveys401_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_list_surveys404_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_list_surveys500_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_list_wells200_response_body.py +86 -0
- em_toolhub-0.1.0/test/test_list_wells200_response_body_data.py +78 -0
- em_toolhub-0.1.0/test/test_list_wells200_response_body_data_wells_inner.py +66 -0
- em_toolhub-0.1.0/test/test_list_wells401_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_list_wells500_response_body.py +62 -0
- em_toolhub-0.1.0/test/test_surveys_api.py +45 -0
- em_toolhub-0.1.0/test/test_wells_api.py +45 -0
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: em_toolhub
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: ToolHub Customer API
|
|
5
|
+
Home-page:
|
|
6
|
+
Author: Erdos Miller
|
|
7
|
+
Author-email: Erdos Miller <team@openapitools.org>
|
|
8
|
+
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
|
|
9
|
+
Keywords: OpenAPI,OpenAPI-Generator,ToolHub Customer API
|
|
10
|
+
Requires-Python: >=3.9
|
|
11
|
+
Description-Content-Type: text/markdown
|
|
12
|
+
Requires-Dist: urllib3<3.0.0,>=2.1.0
|
|
13
|
+
Requires-Dist: python-dateutil>=2.8.2
|
|
14
|
+
Requires-Dist: pydantic>=2
|
|
15
|
+
Requires-Dist: typing-extensions>=4.7.1
|
|
16
|
+
Dynamic: author
|
|
17
|
+
|
|
18
|
+
# em-toolhub
|
|
19
|
+
REST API for customer access to ToolHub well data.
|
|
20
|
+
|
|
21
|
+
## Authentication
|
|
22
|
+
|
|
23
|
+
All endpoints require Bearer token authentication using an API key:
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
Authorization: Bearer thub_live_xxxxxxxxxxxxxxxxxxxx
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
API keys are issued per-organization and inherit well access permissions.
|
|
30
|
+
|
|
31
|
+
## Rate Limits
|
|
32
|
+
|
|
33
|
+
- Standard tier: 70 requests/minute
|
|
34
|
+
- Premium tier: 300 requests/minute
|
|
35
|
+
|
|
36
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
37
|
+
|
|
38
|
+
- API version: 0.1.0
|
|
39
|
+
- Package version: 0.1.0
|
|
40
|
+
- Generator version: 7.19.0-SNAPSHOT
|
|
41
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
42
|
+
For more information, please visit [https://erdosmiller.com](https://erdosmiller.com)
|
|
43
|
+
|
|
44
|
+
## Requirements.
|
|
45
|
+
|
|
46
|
+
Python 3.9+
|
|
47
|
+
|
|
48
|
+
## Installation & Usage
|
|
49
|
+
### pip install
|
|
50
|
+
|
|
51
|
+
If the python package is hosted on a repository, you can install directly using:
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
|
|
55
|
+
```
|
|
56
|
+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
|
|
57
|
+
|
|
58
|
+
Then import the package:
|
|
59
|
+
```python
|
|
60
|
+
import em_toolhub
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Setuptools
|
|
64
|
+
|
|
65
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
66
|
+
|
|
67
|
+
```sh
|
|
68
|
+
python setup.py install --user
|
|
69
|
+
```
|
|
70
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
71
|
+
|
|
72
|
+
Then import the package:
|
|
73
|
+
```python
|
|
74
|
+
import em_toolhub
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Tests
|
|
78
|
+
|
|
79
|
+
Execute `pytest` to run the tests.
|
|
80
|
+
|
|
81
|
+
## Getting Started
|
|
82
|
+
|
|
83
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
84
|
+
|
|
85
|
+
```python
|
|
86
|
+
|
|
87
|
+
import em_toolhub
|
|
88
|
+
from em_toolhub.rest import ApiException
|
|
89
|
+
from pprint import pprint
|
|
90
|
+
|
|
91
|
+
# Defining the host is optional and defaults to http://localhost
|
|
92
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
93
|
+
configuration = em_toolhub.Configuration(
|
|
94
|
+
host = "http://localhost"
|
|
95
|
+
)
|
|
96
|
+
|
|
97
|
+
# The client must configure the authentication and authorization parameters
|
|
98
|
+
# in accordance with the API server security policy.
|
|
99
|
+
# Examples for each auth method are provided below, use the example that
|
|
100
|
+
# satisfies your auth use case.
|
|
101
|
+
|
|
102
|
+
# Configure Bearer authorization (API Key): bearerAuth
|
|
103
|
+
configuration = em_toolhub.Configuration(
|
|
104
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
105
|
+
)
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
# Enter a context with an instance of the API client
|
|
109
|
+
with em_toolhub.ApiClient(configuration) as api_client:
|
|
110
|
+
# Create an instance of the API class
|
|
111
|
+
api_instance = em_toolhub.FilesApi(api_client)
|
|
112
|
+
well_id = 'well_id_example' # str |
|
|
113
|
+
file_id = 'file_id_example' # str |
|
|
114
|
+
|
|
115
|
+
try:
|
|
116
|
+
# Delete a file
|
|
117
|
+
api_response = api_instance.delete_file(well_id, file_id)
|
|
118
|
+
print("The response of FilesApi->delete_file:\n")
|
|
119
|
+
pprint(api_response)
|
|
120
|
+
except ApiException as e:
|
|
121
|
+
print("Exception when calling FilesApi->delete_file: %s\n" % e)
|
|
122
|
+
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
## Documentation for API Endpoints
|
|
126
|
+
|
|
127
|
+
All URIs are relative to *http://localhost*
|
|
128
|
+
|
|
129
|
+
Class | Method | HTTP request | Description
|
|
130
|
+
------------ | ------------- | ------------- | -------------
|
|
131
|
+
*FilesApi* | [**delete_file**](docs/FilesApi.md#delete_file) | **DELETE** /api/v1/wells/{wellId}/files/{fileId} | Delete a file
|
|
132
|
+
*FilesApi* | [**download_file**](docs/FilesApi.md#download_file) | **GET** /api/v1/wells/{wellId}/files/{fileId}/download | Download a file
|
|
133
|
+
*FilesApi* | [**get_file**](docs/FilesApi.md#get_file) | **GET** /api/v1/wells/{wellId}/files/{fileId} | Get file metadata
|
|
134
|
+
*FilesApi* | [**list_files**](docs/FilesApi.md#list_files) | **GET** /api/v1/wells/{wellId}/files | List files
|
|
135
|
+
*SurveysApi* | [**get_survey**](docs/SurveysApi.md#get_survey) | **GET** /api/v1/wells/{wellId}/surveys/{surveyId} | Get survey details
|
|
136
|
+
*SurveysApi* | [**list_surveys**](docs/SurveysApi.md#list_surveys) | **GET** /api/v1/wells/{wellId}/surveys | List surveys for a well
|
|
137
|
+
*WellsApi* | [**get_well**](docs/WellsApi.md#get_well) | **GET** /api/v1/wells/{wellId} | Get well details
|
|
138
|
+
*WellsApi* | [**list_wells**](docs/WellsApi.md#list_wells) | **GET** /api/v1/wells | List wells
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
## Documentation For Models
|
|
142
|
+
|
|
143
|
+
- [DeleteFile401ResponseBody](docs/DeleteFile401ResponseBody.md)
|
|
144
|
+
- [DeleteFile401ResponseBodyError](docs/DeleteFile401ResponseBodyError.md)
|
|
145
|
+
- [DeleteFile401ResponseBodyMeta](docs/DeleteFile401ResponseBodyMeta.md)
|
|
146
|
+
- [DeleteFile404ResponseBody](docs/DeleteFile404ResponseBody.md)
|
|
147
|
+
- [DeleteFile500ResponseBody](docs/DeleteFile500ResponseBody.md)
|
|
148
|
+
- [DownloadFile401ResponseBody](docs/DownloadFile401ResponseBody.md)
|
|
149
|
+
- [DownloadFile404ResponseBody](docs/DownloadFile404ResponseBody.md)
|
|
150
|
+
- [DownloadFile500ResponseBody](docs/DownloadFile500ResponseBody.md)
|
|
151
|
+
- [ErrorMessage](docs/ErrorMessage.md)
|
|
152
|
+
- [GetFile200ResponseBody](docs/GetFile200ResponseBody.md)
|
|
153
|
+
- [GetFile200ResponseBodyData](docs/GetFile200ResponseBodyData.md)
|
|
154
|
+
- [GetFile401ResponseBody](docs/GetFile401ResponseBody.md)
|
|
155
|
+
- [GetFile404ResponseBody](docs/GetFile404ResponseBody.md)
|
|
156
|
+
- [GetFile500ResponseBody](docs/GetFile500ResponseBody.md)
|
|
157
|
+
- [GetSurvey200ResponseBody](docs/GetSurvey200ResponseBody.md)
|
|
158
|
+
- [GetSurvey200ResponseBodyData](docs/GetSurvey200ResponseBodyData.md)
|
|
159
|
+
- [GetSurvey200ResponseBodyDataCorrectionsInner](docs/GetSurvey200ResponseBodyDataCorrectionsInner.md)
|
|
160
|
+
- [GetSurvey200ResponseBodyDataRaw](docs/GetSurvey200ResponseBodyDataRaw.md)
|
|
161
|
+
- [GetSurvey401ResponseBody](docs/GetSurvey401ResponseBody.md)
|
|
162
|
+
- [GetSurvey404ResponseBody](docs/GetSurvey404ResponseBody.md)
|
|
163
|
+
- [GetSurvey500ResponseBody](docs/GetSurvey500ResponseBody.md)
|
|
164
|
+
- [GetWell200ResponseBody](docs/GetWell200ResponseBody.md)
|
|
165
|
+
- [GetWell200ResponseBodyData](docs/GetWell200ResponseBodyData.md)
|
|
166
|
+
- [GetWell200ResponseBodyDataWellboresInner](docs/GetWell200ResponseBodyDataWellboresInner.md)
|
|
167
|
+
- [GetWell401ResponseBody](docs/GetWell401ResponseBody.md)
|
|
168
|
+
- [GetWell404ResponseBody](docs/GetWell404ResponseBody.md)
|
|
169
|
+
- [GetWell500ResponseBody](docs/GetWell500ResponseBody.md)
|
|
170
|
+
- [ListFiles200ResponseBody](docs/ListFiles200ResponseBody.md)
|
|
171
|
+
- [ListFiles200ResponseBodyData](docs/ListFiles200ResponseBodyData.md)
|
|
172
|
+
- [ListFiles200ResponseBodyDataFilesInner](docs/ListFiles200ResponseBodyDataFilesInner.md)
|
|
173
|
+
- [ListFiles401ResponseBody](docs/ListFiles401ResponseBody.md)
|
|
174
|
+
- [ListFiles404ResponseBody](docs/ListFiles404ResponseBody.md)
|
|
175
|
+
- [ListFiles500ResponseBody](docs/ListFiles500ResponseBody.md)
|
|
176
|
+
- [ListSurveys200ResponseBody](docs/ListSurveys200ResponseBody.md)
|
|
177
|
+
- [ListSurveys200ResponseBodyData](docs/ListSurveys200ResponseBodyData.md)
|
|
178
|
+
- [ListSurveys200ResponseBodyDataSurveysInner](docs/ListSurveys200ResponseBodyDataSurveysInner.md)
|
|
179
|
+
- [ListSurveys401ResponseBody](docs/ListSurveys401ResponseBody.md)
|
|
180
|
+
- [ListSurveys404ResponseBody](docs/ListSurveys404ResponseBody.md)
|
|
181
|
+
- [ListSurveys500ResponseBody](docs/ListSurveys500ResponseBody.md)
|
|
182
|
+
- [ListWells200ResponseBody](docs/ListWells200ResponseBody.md)
|
|
183
|
+
- [ListWells200ResponseBodyData](docs/ListWells200ResponseBodyData.md)
|
|
184
|
+
- [ListWells200ResponseBodyDataWellsInner](docs/ListWells200ResponseBodyDataWellsInner.md)
|
|
185
|
+
- [ListWells401ResponseBody](docs/ListWells401ResponseBody.md)
|
|
186
|
+
- [ListWells500ResponseBody](docs/ListWells500ResponseBody.md)
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<a id="documentation-for-authorization"></a>
|
|
190
|
+
## Documentation For Authorization
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
Authentication schemes defined for the API:
|
|
194
|
+
<a id="bearerAuth"></a>
|
|
195
|
+
### bearerAuth
|
|
196
|
+
|
|
197
|
+
- **Type**: Bearer authentication (API Key)
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
## Author
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
# em-toolhub
|
|
2
|
+
REST API for customer access to ToolHub well data.
|
|
3
|
+
|
|
4
|
+
## Authentication
|
|
5
|
+
|
|
6
|
+
All endpoints require Bearer token authentication using an API key:
|
|
7
|
+
|
|
8
|
+
```
|
|
9
|
+
Authorization: Bearer thub_live_xxxxxxxxxxxxxxxxxxxx
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
API keys are issued per-organization and inherit well access permissions.
|
|
13
|
+
|
|
14
|
+
## Rate Limits
|
|
15
|
+
|
|
16
|
+
- Standard tier: 70 requests/minute
|
|
17
|
+
- Premium tier: 300 requests/minute
|
|
18
|
+
|
|
19
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
20
|
+
|
|
21
|
+
- API version: 0.1.0
|
|
22
|
+
- Package version: 0.1.0
|
|
23
|
+
- Generator version: 7.19.0-SNAPSHOT
|
|
24
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
25
|
+
For more information, please visit [https://erdosmiller.com](https://erdosmiller.com)
|
|
26
|
+
|
|
27
|
+
## Requirements.
|
|
28
|
+
|
|
29
|
+
Python 3.9+
|
|
30
|
+
|
|
31
|
+
## Installation & Usage
|
|
32
|
+
### pip install
|
|
33
|
+
|
|
34
|
+
If the python package is hosted on a repository, you can install directly using:
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
|
|
38
|
+
```
|
|
39
|
+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
|
|
40
|
+
|
|
41
|
+
Then import the package:
|
|
42
|
+
```python
|
|
43
|
+
import em_toolhub
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Setuptools
|
|
47
|
+
|
|
48
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
python setup.py install --user
|
|
52
|
+
```
|
|
53
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
54
|
+
|
|
55
|
+
Then import the package:
|
|
56
|
+
```python
|
|
57
|
+
import em_toolhub
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Tests
|
|
61
|
+
|
|
62
|
+
Execute `pytest` to run the tests.
|
|
63
|
+
|
|
64
|
+
## Getting Started
|
|
65
|
+
|
|
66
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
67
|
+
|
|
68
|
+
```python
|
|
69
|
+
|
|
70
|
+
import em_toolhub
|
|
71
|
+
from em_toolhub.rest import ApiException
|
|
72
|
+
from pprint import pprint
|
|
73
|
+
|
|
74
|
+
# Defining the host is optional and defaults to http://localhost
|
|
75
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
76
|
+
configuration = em_toolhub.Configuration(
|
|
77
|
+
host = "http://localhost"
|
|
78
|
+
)
|
|
79
|
+
|
|
80
|
+
# The client must configure the authentication and authorization parameters
|
|
81
|
+
# in accordance with the API server security policy.
|
|
82
|
+
# Examples for each auth method are provided below, use the example that
|
|
83
|
+
# satisfies your auth use case.
|
|
84
|
+
|
|
85
|
+
# Configure Bearer authorization (API Key): bearerAuth
|
|
86
|
+
configuration = em_toolhub.Configuration(
|
|
87
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
88
|
+
)
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
# Enter a context with an instance of the API client
|
|
92
|
+
with em_toolhub.ApiClient(configuration) as api_client:
|
|
93
|
+
# Create an instance of the API class
|
|
94
|
+
api_instance = em_toolhub.FilesApi(api_client)
|
|
95
|
+
well_id = 'well_id_example' # str |
|
|
96
|
+
file_id = 'file_id_example' # str |
|
|
97
|
+
|
|
98
|
+
try:
|
|
99
|
+
# Delete a file
|
|
100
|
+
api_response = api_instance.delete_file(well_id, file_id)
|
|
101
|
+
print("The response of FilesApi->delete_file:\n")
|
|
102
|
+
pprint(api_response)
|
|
103
|
+
except ApiException as e:
|
|
104
|
+
print("Exception when calling FilesApi->delete_file: %s\n" % e)
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Documentation for API Endpoints
|
|
109
|
+
|
|
110
|
+
All URIs are relative to *http://localhost*
|
|
111
|
+
|
|
112
|
+
Class | Method | HTTP request | Description
|
|
113
|
+
------------ | ------------- | ------------- | -------------
|
|
114
|
+
*FilesApi* | [**delete_file**](docs/FilesApi.md#delete_file) | **DELETE** /api/v1/wells/{wellId}/files/{fileId} | Delete a file
|
|
115
|
+
*FilesApi* | [**download_file**](docs/FilesApi.md#download_file) | **GET** /api/v1/wells/{wellId}/files/{fileId}/download | Download a file
|
|
116
|
+
*FilesApi* | [**get_file**](docs/FilesApi.md#get_file) | **GET** /api/v1/wells/{wellId}/files/{fileId} | Get file metadata
|
|
117
|
+
*FilesApi* | [**list_files**](docs/FilesApi.md#list_files) | **GET** /api/v1/wells/{wellId}/files | List files
|
|
118
|
+
*SurveysApi* | [**get_survey**](docs/SurveysApi.md#get_survey) | **GET** /api/v1/wells/{wellId}/surveys/{surveyId} | Get survey details
|
|
119
|
+
*SurveysApi* | [**list_surveys**](docs/SurveysApi.md#list_surveys) | **GET** /api/v1/wells/{wellId}/surveys | List surveys for a well
|
|
120
|
+
*WellsApi* | [**get_well**](docs/WellsApi.md#get_well) | **GET** /api/v1/wells/{wellId} | Get well details
|
|
121
|
+
*WellsApi* | [**list_wells**](docs/WellsApi.md#list_wells) | **GET** /api/v1/wells | List wells
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
## Documentation For Models
|
|
125
|
+
|
|
126
|
+
- [DeleteFile401ResponseBody](docs/DeleteFile401ResponseBody.md)
|
|
127
|
+
- [DeleteFile401ResponseBodyError](docs/DeleteFile401ResponseBodyError.md)
|
|
128
|
+
- [DeleteFile401ResponseBodyMeta](docs/DeleteFile401ResponseBodyMeta.md)
|
|
129
|
+
- [DeleteFile404ResponseBody](docs/DeleteFile404ResponseBody.md)
|
|
130
|
+
- [DeleteFile500ResponseBody](docs/DeleteFile500ResponseBody.md)
|
|
131
|
+
- [DownloadFile401ResponseBody](docs/DownloadFile401ResponseBody.md)
|
|
132
|
+
- [DownloadFile404ResponseBody](docs/DownloadFile404ResponseBody.md)
|
|
133
|
+
- [DownloadFile500ResponseBody](docs/DownloadFile500ResponseBody.md)
|
|
134
|
+
- [ErrorMessage](docs/ErrorMessage.md)
|
|
135
|
+
- [GetFile200ResponseBody](docs/GetFile200ResponseBody.md)
|
|
136
|
+
- [GetFile200ResponseBodyData](docs/GetFile200ResponseBodyData.md)
|
|
137
|
+
- [GetFile401ResponseBody](docs/GetFile401ResponseBody.md)
|
|
138
|
+
- [GetFile404ResponseBody](docs/GetFile404ResponseBody.md)
|
|
139
|
+
- [GetFile500ResponseBody](docs/GetFile500ResponseBody.md)
|
|
140
|
+
- [GetSurvey200ResponseBody](docs/GetSurvey200ResponseBody.md)
|
|
141
|
+
- [GetSurvey200ResponseBodyData](docs/GetSurvey200ResponseBodyData.md)
|
|
142
|
+
- [GetSurvey200ResponseBodyDataCorrectionsInner](docs/GetSurvey200ResponseBodyDataCorrectionsInner.md)
|
|
143
|
+
- [GetSurvey200ResponseBodyDataRaw](docs/GetSurvey200ResponseBodyDataRaw.md)
|
|
144
|
+
- [GetSurvey401ResponseBody](docs/GetSurvey401ResponseBody.md)
|
|
145
|
+
- [GetSurvey404ResponseBody](docs/GetSurvey404ResponseBody.md)
|
|
146
|
+
- [GetSurvey500ResponseBody](docs/GetSurvey500ResponseBody.md)
|
|
147
|
+
- [GetWell200ResponseBody](docs/GetWell200ResponseBody.md)
|
|
148
|
+
- [GetWell200ResponseBodyData](docs/GetWell200ResponseBodyData.md)
|
|
149
|
+
- [GetWell200ResponseBodyDataWellboresInner](docs/GetWell200ResponseBodyDataWellboresInner.md)
|
|
150
|
+
- [GetWell401ResponseBody](docs/GetWell401ResponseBody.md)
|
|
151
|
+
- [GetWell404ResponseBody](docs/GetWell404ResponseBody.md)
|
|
152
|
+
- [GetWell500ResponseBody](docs/GetWell500ResponseBody.md)
|
|
153
|
+
- [ListFiles200ResponseBody](docs/ListFiles200ResponseBody.md)
|
|
154
|
+
- [ListFiles200ResponseBodyData](docs/ListFiles200ResponseBodyData.md)
|
|
155
|
+
- [ListFiles200ResponseBodyDataFilesInner](docs/ListFiles200ResponseBodyDataFilesInner.md)
|
|
156
|
+
- [ListFiles401ResponseBody](docs/ListFiles401ResponseBody.md)
|
|
157
|
+
- [ListFiles404ResponseBody](docs/ListFiles404ResponseBody.md)
|
|
158
|
+
- [ListFiles500ResponseBody](docs/ListFiles500ResponseBody.md)
|
|
159
|
+
- [ListSurveys200ResponseBody](docs/ListSurveys200ResponseBody.md)
|
|
160
|
+
- [ListSurveys200ResponseBodyData](docs/ListSurveys200ResponseBodyData.md)
|
|
161
|
+
- [ListSurveys200ResponseBodyDataSurveysInner](docs/ListSurveys200ResponseBodyDataSurveysInner.md)
|
|
162
|
+
- [ListSurveys401ResponseBody](docs/ListSurveys401ResponseBody.md)
|
|
163
|
+
- [ListSurveys404ResponseBody](docs/ListSurveys404ResponseBody.md)
|
|
164
|
+
- [ListSurveys500ResponseBody](docs/ListSurveys500ResponseBody.md)
|
|
165
|
+
- [ListWells200ResponseBody](docs/ListWells200ResponseBody.md)
|
|
166
|
+
- [ListWells200ResponseBodyData](docs/ListWells200ResponseBodyData.md)
|
|
167
|
+
- [ListWells200ResponseBodyDataWellsInner](docs/ListWells200ResponseBodyDataWellsInner.md)
|
|
168
|
+
- [ListWells401ResponseBody](docs/ListWells401ResponseBody.md)
|
|
169
|
+
- [ListWells500ResponseBody](docs/ListWells500ResponseBody.md)
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
<a id="documentation-for-authorization"></a>
|
|
173
|
+
## Documentation For Authorization
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
Authentication schemes defined for the API:
|
|
177
|
+
<a id="bearerAuth"></a>
|
|
178
|
+
### bearerAuth
|
|
179
|
+
|
|
180
|
+
- **Type**: Bearer authentication (API Key)
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
## Author
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
# flake8: noqa
|
|
4
|
+
|
|
5
|
+
"""
|
|
6
|
+
ToolHub Customer API
|
|
7
|
+
|
|
8
|
+
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
|
|
9
|
+
|
|
10
|
+
The version of the OpenAPI document: 0.1.0
|
|
11
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
12
|
+
|
|
13
|
+
Do not edit the class manually.
|
|
14
|
+
""" # noqa: E501
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
__version__ = "0.1.0"
|
|
18
|
+
|
|
19
|
+
# Define package exports
|
|
20
|
+
__all__ = [
|
|
21
|
+
"FilesApi",
|
|
22
|
+
"SurveysApi",
|
|
23
|
+
"WellsApi",
|
|
24
|
+
"ApiResponse",
|
|
25
|
+
"ApiClient",
|
|
26
|
+
"Configuration",
|
|
27
|
+
"OpenApiException",
|
|
28
|
+
"ApiTypeError",
|
|
29
|
+
"ApiValueError",
|
|
30
|
+
"ApiKeyError",
|
|
31
|
+
"ApiAttributeError",
|
|
32
|
+
"ApiException",
|
|
33
|
+
"DeleteFile401ResponseBody",
|
|
34
|
+
"DeleteFile401ResponseBodyError",
|
|
35
|
+
"DeleteFile401ResponseBodyMeta",
|
|
36
|
+
"DeleteFile404ResponseBody",
|
|
37
|
+
"DeleteFile500ResponseBody",
|
|
38
|
+
"DownloadFile401ResponseBody",
|
|
39
|
+
"DownloadFile404ResponseBody",
|
|
40
|
+
"DownloadFile500ResponseBody",
|
|
41
|
+
"ErrorMessage",
|
|
42
|
+
"GetFile200ResponseBody",
|
|
43
|
+
"GetFile200ResponseBodyData",
|
|
44
|
+
"GetFile401ResponseBody",
|
|
45
|
+
"GetFile404ResponseBody",
|
|
46
|
+
"GetFile500ResponseBody",
|
|
47
|
+
"GetSurvey200ResponseBody",
|
|
48
|
+
"GetSurvey200ResponseBodyData",
|
|
49
|
+
"GetSurvey200ResponseBodyDataCorrectionsInner",
|
|
50
|
+
"GetSurvey200ResponseBodyDataRaw",
|
|
51
|
+
"GetSurvey401ResponseBody",
|
|
52
|
+
"GetSurvey404ResponseBody",
|
|
53
|
+
"GetSurvey500ResponseBody",
|
|
54
|
+
"GetWell200ResponseBody",
|
|
55
|
+
"GetWell200ResponseBodyData",
|
|
56
|
+
"GetWell200ResponseBodyDataWellboresInner",
|
|
57
|
+
"GetWell401ResponseBody",
|
|
58
|
+
"GetWell404ResponseBody",
|
|
59
|
+
"GetWell500ResponseBody",
|
|
60
|
+
"ListFiles200ResponseBody",
|
|
61
|
+
"ListFiles200ResponseBodyData",
|
|
62
|
+
"ListFiles200ResponseBodyDataFilesInner",
|
|
63
|
+
"ListFiles401ResponseBody",
|
|
64
|
+
"ListFiles404ResponseBody",
|
|
65
|
+
"ListFiles500ResponseBody",
|
|
66
|
+
"ListSurveys200ResponseBody",
|
|
67
|
+
"ListSurveys200ResponseBodyData",
|
|
68
|
+
"ListSurveys200ResponseBodyDataSurveysInner",
|
|
69
|
+
"ListSurveys401ResponseBody",
|
|
70
|
+
"ListSurveys404ResponseBody",
|
|
71
|
+
"ListSurveys500ResponseBody",
|
|
72
|
+
"ListWells200ResponseBody",
|
|
73
|
+
"ListWells200ResponseBodyData",
|
|
74
|
+
"ListWells200ResponseBodyDataWellsInner",
|
|
75
|
+
"ListWells401ResponseBody",
|
|
76
|
+
"ListWells500ResponseBody",
|
|
77
|
+
]
|
|
78
|
+
|
|
79
|
+
# import apis into sdk package
|
|
80
|
+
from em_toolhub.api.files_api import FilesApi as FilesApi
|
|
81
|
+
from em_toolhub.api.surveys_api import SurveysApi as SurveysApi
|
|
82
|
+
from em_toolhub.api.wells_api import WellsApi as WellsApi
|
|
83
|
+
|
|
84
|
+
# import ApiClient
|
|
85
|
+
from em_toolhub.api_response import ApiResponse as ApiResponse
|
|
86
|
+
from em_toolhub.api_client import ApiClient as ApiClient
|
|
87
|
+
from em_toolhub.configuration import Configuration as Configuration
|
|
88
|
+
from em_toolhub.exceptions import OpenApiException as OpenApiException
|
|
89
|
+
from em_toolhub.exceptions import ApiTypeError as ApiTypeError
|
|
90
|
+
from em_toolhub.exceptions import ApiValueError as ApiValueError
|
|
91
|
+
from em_toolhub.exceptions import ApiKeyError as ApiKeyError
|
|
92
|
+
from em_toolhub.exceptions import ApiAttributeError as ApiAttributeError
|
|
93
|
+
from em_toolhub.exceptions import ApiException as ApiException
|
|
94
|
+
|
|
95
|
+
# import models into sdk package
|
|
96
|
+
from em_toolhub.models.delete_file401_response_body import DeleteFile401ResponseBody as DeleteFile401ResponseBody
|
|
97
|
+
from em_toolhub.models.delete_file401_response_body_error import DeleteFile401ResponseBodyError as DeleteFile401ResponseBodyError
|
|
98
|
+
from em_toolhub.models.delete_file401_response_body_meta import DeleteFile401ResponseBodyMeta as DeleteFile401ResponseBodyMeta
|
|
99
|
+
from em_toolhub.models.delete_file404_response_body import DeleteFile404ResponseBody as DeleteFile404ResponseBody
|
|
100
|
+
from em_toolhub.models.delete_file500_response_body import DeleteFile500ResponseBody as DeleteFile500ResponseBody
|
|
101
|
+
from em_toolhub.models.download_file401_response_body import DownloadFile401ResponseBody as DownloadFile401ResponseBody
|
|
102
|
+
from em_toolhub.models.download_file404_response_body import DownloadFile404ResponseBody as DownloadFile404ResponseBody
|
|
103
|
+
from em_toolhub.models.download_file500_response_body import DownloadFile500ResponseBody as DownloadFile500ResponseBody
|
|
104
|
+
from em_toolhub.models.error_message import ErrorMessage as ErrorMessage
|
|
105
|
+
from em_toolhub.models.get_file200_response_body import GetFile200ResponseBody as GetFile200ResponseBody
|
|
106
|
+
from em_toolhub.models.get_file200_response_body_data import GetFile200ResponseBodyData as GetFile200ResponseBodyData
|
|
107
|
+
from em_toolhub.models.get_file401_response_body import GetFile401ResponseBody as GetFile401ResponseBody
|
|
108
|
+
from em_toolhub.models.get_file404_response_body import GetFile404ResponseBody as GetFile404ResponseBody
|
|
109
|
+
from em_toolhub.models.get_file500_response_body import GetFile500ResponseBody as GetFile500ResponseBody
|
|
110
|
+
from em_toolhub.models.get_survey200_response_body import GetSurvey200ResponseBody as GetSurvey200ResponseBody
|
|
111
|
+
from em_toolhub.models.get_survey200_response_body_data import GetSurvey200ResponseBodyData as GetSurvey200ResponseBodyData
|
|
112
|
+
from em_toolhub.models.get_survey200_response_body_data_corrections_inner import GetSurvey200ResponseBodyDataCorrectionsInner as GetSurvey200ResponseBodyDataCorrectionsInner
|
|
113
|
+
from em_toolhub.models.get_survey200_response_body_data_raw import GetSurvey200ResponseBodyDataRaw as GetSurvey200ResponseBodyDataRaw
|
|
114
|
+
from em_toolhub.models.get_survey401_response_body import GetSurvey401ResponseBody as GetSurvey401ResponseBody
|
|
115
|
+
from em_toolhub.models.get_survey404_response_body import GetSurvey404ResponseBody as GetSurvey404ResponseBody
|
|
116
|
+
from em_toolhub.models.get_survey500_response_body import GetSurvey500ResponseBody as GetSurvey500ResponseBody
|
|
117
|
+
from em_toolhub.models.get_well200_response_body import GetWell200ResponseBody as GetWell200ResponseBody
|
|
118
|
+
from em_toolhub.models.get_well200_response_body_data import GetWell200ResponseBodyData as GetWell200ResponseBodyData
|
|
119
|
+
from em_toolhub.models.get_well200_response_body_data_wellbores_inner import GetWell200ResponseBodyDataWellboresInner as GetWell200ResponseBodyDataWellboresInner
|
|
120
|
+
from em_toolhub.models.get_well401_response_body import GetWell401ResponseBody as GetWell401ResponseBody
|
|
121
|
+
from em_toolhub.models.get_well404_response_body import GetWell404ResponseBody as GetWell404ResponseBody
|
|
122
|
+
from em_toolhub.models.get_well500_response_body import GetWell500ResponseBody as GetWell500ResponseBody
|
|
123
|
+
from em_toolhub.models.list_files200_response_body import ListFiles200ResponseBody as ListFiles200ResponseBody
|
|
124
|
+
from em_toolhub.models.list_files200_response_body_data import ListFiles200ResponseBodyData as ListFiles200ResponseBodyData
|
|
125
|
+
from em_toolhub.models.list_files200_response_body_data_files_inner import ListFiles200ResponseBodyDataFilesInner as ListFiles200ResponseBodyDataFilesInner
|
|
126
|
+
from em_toolhub.models.list_files401_response_body import ListFiles401ResponseBody as ListFiles401ResponseBody
|
|
127
|
+
from em_toolhub.models.list_files404_response_body import ListFiles404ResponseBody as ListFiles404ResponseBody
|
|
128
|
+
from em_toolhub.models.list_files500_response_body import ListFiles500ResponseBody as ListFiles500ResponseBody
|
|
129
|
+
from em_toolhub.models.list_surveys200_response_body import ListSurveys200ResponseBody as ListSurveys200ResponseBody
|
|
130
|
+
from em_toolhub.models.list_surveys200_response_body_data import ListSurveys200ResponseBodyData as ListSurveys200ResponseBodyData
|
|
131
|
+
from em_toolhub.models.list_surveys200_response_body_data_surveys_inner import ListSurveys200ResponseBodyDataSurveysInner as ListSurveys200ResponseBodyDataSurveysInner
|
|
132
|
+
from em_toolhub.models.list_surveys401_response_body import ListSurveys401ResponseBody as ListSurveys401ResponseBody
|
|
133
|
+
from em_toolhub.models.list_surveys404_response_body import ListSurveys404ResponseBody as ListSurveys404ResponseBody
|
|
134
|
+
from em_toolhub.models.list_surveys500_response_body import ListSurveys500ResponseBody as ListSurveys500ResponseBody
|
|
135
|
+
from em_toolhub.models.list_wells200_response_body import ListWells200ResponseBody as ListWells200ResponseBody
|
|
136
|
+
from em_toolhub.models.list_wells200_response_body_data import ListWells200ResponseBodyData as ListWells200ResponseBodyData
|
|
137
|
+
from em_toolhub.models.list_wells200_response_body_data_wells_inner import ListWells200ResponseBodyDataWellsInner as ListWells200ResponseBodyDataWellsInner
|
|
138
|
+
from em_toolhub.models.list_wells401_response_body import ListWells401ResponseBody as ListWells401ResponseBody
|
|
139
|
+
from em_toolhub.models.list_wells500_response_body import ListWells500ResponseBody as ListWells500ResponseBody
|
|
140
|
+
|