# EHESO API Client for Python
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: v1
- Package version: 0.1.10
- Generator version: 7.7.0
- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
## Requirements.
Python 3.7+
# Installation & Usage
## pip install
```sh
pip install eheso-api-client
```
## Post-Installation Setup
After installing the package, you need to create a .env file in the source folder containing the API key for server access.
**Steps to Create the `.env` File:**
1. Navigate to the folder where the package is installed or the source folder of your project.
2. Create a file named `.env`.
3. Add the following line to the `.env` file:
```env
API_KEY="your_api_key_here"
```
Replace `your_api_key_here` with the actual API key provided to you.
For example:
```env
API_KEY=abcd1234efgh5678ijkl
```
Save the `.env` file.
#### Note
- The package uses the `.env` file to securely load the API key into the application.
- Please make sure the .env file is not included in version control systems like Git (add .env to your .gitignore).
# Getting Started
After installing the package and creating the `.env` file, run the following code:
```py
import time
import eheso_api_client
from eheso_api_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://observatory.local:3001/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = eheso_api_client.Configuration(
host = "http://observatory.local:3001/api/v1"
)
# 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with eheso_api_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = eheso_api_client.LayerDataApi(api_client)
layer_id = 'HEI' # str | The ID of the layer
layer_id_export_request = eheso_api_client.LayerIdExportRequest() # LayerIdExportRequest |
try:
# Export Layer Data to File
api_instance.layer_id_export(layer_id, layer_id_export_request)
except ApiException as e:
print("Exception when calling LayerDataApi->layer_id_export: %s\n" % e)
```
# License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "eheso-api-client",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, EHESO API",
"author": "OpenAPI Generator community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/62/cd/7a58fe1cc89b5f276b8a10a5b4feae8c3c8c4349fa11f6c3e06338dd3103/eheso_api_client-0.1.10.tar.gz",
"platform": null,
"description": "# EHESO API Client for Python\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: v1\n- Package version: 0.1.10\n- Generator version: 7.7.0\n- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n# Installation & Usage\n## pip install\n\n```sh\npip install eheso-api-client\n```\n\n## Post-Installation Setup\nAfter installing the package, you need to create a .env file in the source folder containing the API key for server access.\n\n**Steps to Create the `.env` File:**\n1. Navigate to the folder where the package is installed or the source folder of your project.\n2. Create a file named `.env`.\n3. Add the following line to the `.env` file:\n\n```env\nAPI_KEY=\"your_api_key_here\"\n```\nReplace `your_api_key_here` with the actual API key provided to you.\n\nFor example:\n```env\nAPI_KEY=abcd1234efgh5678ijkl\n```\nSave the `.env` file.\n\n#### Note\n- The package uses the `.env` file to securely load the API key into the application.\n- Please make sure the .env file is not included in version control systems like Git (add .env to your .gitignore).\n\n# Getting Started\n\nAfter installing the package and creating the `.env` file, run the following code:\n\n```py\n\nimport time\nimport eheso_api_client\nfrom eheso_api_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://observatory.local:3001/api/v1\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = eheso_api_client.Configuration(\n host = \"http://observatory.local:3001/api/v1\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: ApiKeyAuth\nconfiguration.api_key['ApiKeyAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith eheso_api_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = eheso_api_client.LayerDataApi(api_client)\n layer_id = 'HEI' # str | The ID of the layer\n layer_id_export_request = eheso_api_client.LayerIdExportRequest() # LayerIdExportRequest | \n\n try:\n # Export Layer Data to File\n api_instance.layer_id_export(layer_id, layer_id_export_request)\n except ApiException as e:\n print(\"Exception when calling LayerDataApi->layer_id_export: %s\\n\" % e)\n\n```\n\n# License\nThis project is licensed under the MIT License.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "EHESO API",
"version": "0.1.10",
"project_urls": null,
"split_keywords": [
"openapi",
" openapi-generator",
" eheso api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1a6056aeeef04fc3c4ac6282febb711c6b934fb0b2f843d902bde39ddd1a700f",
"md5": "4ae9a6aefe6b80fcb673d2019c7b5315",
"sha256": "979259cb6654568a846173bf211141384e76942abf609ff4d4757d27273a8147"
},
"downloads": -1,
"filename": "eheso_api_client-0.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ae9a6aefe6b80fcb673d2019c7b5315",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 46866,
"upload_time": "2024-11-26T10:41:49",
"upload_time_iso_8601": "2024-11-26T10:41:49.728283Z",
"url": "https://files.pythonhosted.org/packages/1a/60/56aeeef04fc3c4ac6282febb711c6b934fb0b2f843d902bde39ddd1a700f/eheso_api_client-0.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "62cd7a58fe1cc89b5f276b8a10a5b4feae8c3c8c4349fa11f6c3e06338dd3103",
"md5": "163ae5bf9979f11567abea4321ae00a9",
"sha256": "fc86aaba0c0d5888e0d49a470ef5c5e2607a9e3c046da0f9c2a0ff819b3683fc"
},
"downloads": -1,
"filename": "eheso_api_client-0.1.10.tar.gz",
"has_sig": false,
"md5_digest": "163ae5bf9979f11567abea4321ae00a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30662,
"upload_time": "2024-11-26T10:41:51",
"upload_time_iso_8601": "2024-11-26T10:41:51.321681Z",
"url": "https://files.pythonhosted.org/packages/62/cd/7a58fe1cc89b5f276b8a10a5b4feae8c3c8c4349fa11f6c3e06338dd3103/eheso_api_client-0.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 10:41:51",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "eheso-api-client"
}
JSON