eheso-api-client 0.1.10

EHESO API

EHESO API Client for Python

This Python package is automatically generated by the OpenAPI Generator 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

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:

API_KEY="your_api_key_here"

Replace your_api_key_here with the actual API key provided to you.

For example:

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:

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.