Metadata-Version: 2.4
Name: cosmotech.asset_data_layer_client
Version: 0.2.0rc1
Summary: Asset Data Layer
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Asset Data Layer
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.7.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: license-file

# cosmotech-asset-data-layer-client
API for Asset Data Layer

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 0.2.0-rc1
- Generator version: 7.26.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.10+

Packaging uses standard `[project]` metadata and `[dependency-groups]` (PEP 621/735).
Install the package with `python -m pip install .`; install development dependencies
with Poetry 2.2 or newer using `poetry install`, or pip 25.1 or newer using
`python -m pip install --group dev`. The latter installs the group, not the package.

## Installation & Usage
### pip install

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

```sh
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:
```python
import cosmotech.asset_data_layer_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import cosmotech.asset_data_layer_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import cosmotech.asset_data_layer_client
from cosmotech.asset_data_layer_client.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 = cosmotech.asset_data_layer_client.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.

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


# Enter a context with an instance of the API client
with cosmotech.asset_data_layer_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech.asset_data_layer_client.CSMAPIApi(api_client)
    offset = 0 # int | Number of records to skip (optional) (default to 0)
    limit = 100 # int | Max number of records to return (optional) (default to 100)

    try:
        # List csm organizations
        api_response = api_instance.list_csm_organizations_csm_organizations_get(offset=offset, limit=limit)
        print("The response of CSMAPIApi->list_csm_organizations_csm_organizations_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CSMAPIApi->list_csm_organizations_csm_organizations_get: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CSMAPIApi* | [**list_csm_organizations_csm_organizations_get**](docs/CSMAPIApi.md#list_csm_organizations_csm_organizations_get) | **GET** /csm/organizations | List csm organizations
*DatasetsApi* | [**create_dataset**](docs/DatasetsApi.md#create_dataset) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Create a dataset
*DatasetsApi* | [**create_dataset_access**](docs/DatasetsApi.md#create_dataset_access) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access | Share a dataset with a user or group
*DatasetsApi* | [**delete_dataset**](docs/DatasetsApi.md#delete_dataset) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Delete a dataset
*DatasetsApi* | [**delete_dataset_access**](docs/DatasetsApi.md#delete_dataset_access) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Revoke a dataset access
*DatasetsApi* | [**delete_dataset_file**](docs/DatasetsApi.md#delete_dataset_file) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/files/{file_name} | Delete a file from a dataset
*DatasetsApi* | [**download_dataset**](docs/DatasetsApi.md#download_dataset) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/archive | Download a whole dataset as a zip file
*DatasetsApi* | [**download_transformed_dataset**](docs/DatasetsApi.md#download_transformed_dataset) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/transformed-data | Download the transformed dataset, waiting for the transformation
*DatasetsApi* | [**get_dataset**](docs/DatasetsApi.md#get_dataset) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Get a dataset (detailed view)
*DatasetsApi* | [**get_dataset_security**](docs/DatasetsApi.md#get_dataset_security) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security | Get the security of a dataset
*DatasetsApi* | [**get_dataset_transformation_status**](docs/DatasetsApi.md#get_dataset_transformation_status) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/transformation-status | Read a dataset&#39;s latest transformation state
*DatasetsApi* | [**get_dataset_validation_status**](docs/DatasetsApi.md#get_dataset_validation_status) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/validation-status | Read a dataset&#39;s latest validation result
*DatasetsApi* | [**get_file**](docs/DatasetsApi.md#get_file) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/files/{file_path} | Get a file from a dataset
*DatasetsApi* | [**list_datasets**](docs/DatasetsApi.md#list_datasets) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | List datasets (listing view)
*DatasetsApi* | [**transform_dataset**](docs/DatasetsApi.md#transform_dataset) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/transform | Start transforming a validated dataset
*DatasetsApi* | [**update_dataset**](docs/DatasetsApi.md#update_dataset) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Update a dataset&#39;s metadata
*DatasetsApi* | [**update_dataset_access**](docs/DatasetsApi.md#update_dataset_access) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Change the role of a dataset access
*DatasetsApi* | [**upload_dataset_data**](docs/DatasetsApi.md#upload_dataset_data) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/data | Upload data into an existing dataset
*DatasetsApi* | [**validate_dataset**](docs/DatasetsApi.md#validate_dataset) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/validate | Start validating a dataset&#39;s uploaded data
*RunnersApi* | [**get_runner**](docs/RunnersApi.md#get_runner) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Get runner
*RunnersApi* | [**list_runners**](docs/RunnersApi.md#list_runners) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners | List runners
*RunnersApi* | [**update_runner**](docs/RunnersApi.md#update_runner) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Update runner
*ScenariosApi* | [**create_scenario**](docs/ScenariosApi.md#create_scenario) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios | Create a scenario of a dataset, and its runner
*ScenariosApi* | [**delete_scenario**](docs/ScenariosApi.md#delete_scenario) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id} | Delete a scenario, its children, their editions and their runners
*ScenariosApi* | [**download_scenario_table**](docs/ScenariosApi.md#download_scenario_table) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/tables/{table_name} | Download the scenario&#39;s current version of one table, for editing
*ScenariosApi* | [**download_transformed_scenario**](docs/ScenariosApi.md#download_transformed_scenario) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/transformed-data | Download the scenario&#39;s transformed dataset, transforming it if needed
*ScenariosApi* | [**get_scenario**](docs/ScenariosApi.md#get_scenario) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id} | Get a scenario, its editions and its validation state
*ScenariosApi* | [**revert_scenario_table**](docs/ScenariosApi.md#revert_scenario_table) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/tables/{table_name} | Drop the scenario&#39;s own edits of one table
*ScenariosApi* | [**transform_scenario**](docs/ScenariosApi.md#transform_scenario) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/transform | Transform the scenario&#39;s validated edited dataset
*ScenariosApi* | [**upload_scenario_table**](docs/ScenariosApi.md#upload_scenario_table) | **PUT** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/tables/{table_name} | Upload an edited table; only its diff against the parent is stored
*ScenariosApi* | [**validate_scenario**](docs/ScenariosApi.md#validate_scenario) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/validate | Validate the scenario&#39;s whole edited dataset
*DefaultApi* | [**root**](docs/DefaultApi.md#root) | **GET** /about | Root


## Documentation For Models

 - [DatasetAccessCreateRequest](docs/DatasetAccessCreateRequest.md)
 - [DatasetAccessResponse](docs/DatasetAccessResponse.md)
 - [DatasetAccessUpdateRequest](docs/DatasetAccessUpdateRequest.md)
 - [DatasetDetailResponse](docs/DatasetDetailResponse.md)
 - [DatasetFileResponse](docs/DatasetFileResponse.md)
 - [DatasetListItemResponse](docs/DatasetListItemResponse.md)
 - [DatasetRole](docs/DatasetRole.md)
 - [DatasetScenarioResponse](docs/DatasetScenarioResponse.md)
 - [DatasetSecurityResponse](docs/DatasetSecurityResponse.md)
 - [DatasetStatus](docs/DatasetStatus.md)
 - [DatasetTransformationStatusResponse](docs/DatasetTransformationStatusResponse.md)
 - [DatasetValidationDiagnosticResponse](docs/DatasetValidationDiagnosticResponse.md)
 - [DatasetValidationStatusResponse](docs/DatasetValidationStatusResponse.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [LocationInner](docs/LocationInner.md)
 - [Metadata](docs/Metadata.md)
 - [ResourceSizeInfo](docs/ResourceSizeInfo.md)
 - [RunTiming](docs/RunTiming.md)
 - [RunTimingNode](docs/RunTimingNode.md)
 - [RunTimingStep](docs/RunTimingStep.md)
 - [RunnerListItemResponse](docs/RunnerListItemResponse.md)
 - [RunnerResourceSizing](docs/RunnerResourceSizing.md)
 - [RunnerResponse](docs/RunnerResponse.md)
 - [RunnerRunTemplateParameterValue](docs/RunnerRunTemplateParameterValue.md)
 - [RunnerUpdateRequest](docs/RunnerUpdateRequest.md)
 - [RunnerValidationStatus](docs/RunnerValidationStatus.md)
 - [ScenarioCreateRequest](docs/ScenarioCreateRequest.md)
 - [ScenarioDiagnosticResponse](docs/ScenarioDiagnosticResponse.md)
 - [ScenarioEditionResponse](docs/ScenarioEditionResponse.md)
 - [ScenarioResponse](docs/ScenarioResponse.md)
 - [ScenarioState](docs/ScenarioState.md)
 - [ScenarioTransformationResponse](docs/ScenarioTransformationResponse.md)
 - [ValidationError](docs/ValidationError.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="OAuth2AuthorizationCodeBearer"></a>
### OAuth2AuthorizationCodeBearer

- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: /protocol/openid-connect/auth
- **Scopes**: N/A


## Author



