aurigma-asset-storage-api-client

Python client library for Aurigma Asset Storage API.

Requirements.

• Python 3.9+
• Dependencies:
  • python-dateutil>=2.8.2
  • httpx>=0.28.1
  • pydantic>=2
  • typing-extensions>=4.7.1

Installation & Usage

pip install

pip install aurigma-asset-storage-api-client

Then import the package:

import aurigma.asset_storage

Getting Started

In your own code, to use this library to connect and interact with aurigma-asset-storage-api-client, you can run the following:

import aurigma.asset_storage
from aurigma.asset_storage.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configuration parameters.
configuration = aurigma.asset_storage.Configuration(
    host = "http://api.customerscanvashub.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 API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
async with aurigma.asset_storage.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = aurigma.asset_storage.ArtifactsApi(api_client)
    file = None # bytearray | File content.
    name = 'name_example' # str | Entity name.
    tenant_id = 56 # int | Tenant ID. (optional)
    description = 'description_example' # str | Artifact description. (optional)
    group = 'group_example' # str | Artifact group. (optional)
    alias = 'alias_example' # str | Artifact alias (special name within group). (optional)
    type = aurigma.asset_storage.ArtifactType() # ArtifactType | Artifact type. (optional)
    format = 'format_example' # str | Artifact file format. (optional)
    anonymous_access = True # bool | Artifact 'anonymous access' tag. It indicates whether artifact can be accessed anonymously. (optional)
    custom_fields = None # Dict[str, Optional[object]] | Entity custom attributes. (optional)

    try:
        # Creates a new entity.
        api_response = await api_instance.artifacts_create(file, name, tenant_id=tenant_id, description=description, group=group, alias=alias, type=type, format=format, anonymous_access=anonymous_access, custom_fields=custom_fields)
        print("The response of ArtifactsApi->artifacts_create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ArtifactsApi->artifacts_create: %s\n" % e)