# depot-api
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.1.0
- Package version: 1.0.0
- Generator version: 7.4.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## 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 depot_api
```
### 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 depot_api
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import depot_api
from depot_api.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 = depot_api.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 depot_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = depot_api.DefaultApi(api_client)
cluster_in = depot_api.ClusterIn() # ClusterIn |
try:
# Create Cluster
api_response = api_instance.create_cluster_clusters_post(cluster_in)
print("The response of DefaultApi->create_cluster_clusters_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->create_cluster_clusters_post: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**create_cluster_clusters_post**](docs/DefaultApi.md#create_cluster_clusters_post) | **POST** /clusters/ | Create Cluster
*DefaultApi* | [**create_job_instance_job_instances_post**](docs/DefaultApi.md#create_job_instance_job_instances_post) | **POST** /job_instances/ | Create Job Instance
*DefaultApi* | [**create_provider_providers_post**](docs/DefaultApi.md#create_provider_providers_post) | **POST** /providers/ | Create Provider
*DefaultApi* | [**delete_cluster_clusters_cluster_id_delete**](docs/DefaultApi.md#delete_cluster_clusters_cluster_id_delete) | **DELETE** /clusters/{cluster_id} | Delete Cluster
*DefaultApi* | [**delete_job_instance_job_instances_job_instance_id_delete**](docs/DefaultApi.md#delete_job_instance_job_instances_job_instance_id_delete) | **DELETE** /job_instances/{job_instance_id} | Delete Job Instance
*DefaultApi* | [**delete_provider_providers_provider_id_delete**](docs/DefaultApi.md#delete_provider_providers_provider_id_delete) | **DELETE** /providers/{provider_id} | Delete Provider
*DefaultApi* | [**list_clusters_clusters_get**](docs/DefaultApi.md#list_clusters_clusters_get) | **GET** /clusters/ | List Clusters
*DefaultApi* | [**list_job_instances_job_instances_get**](docs/DefaultApi.md#list_job_instances_job_instances_get) | **GET** /job_instances/ | List Job Instances
*DefaultApi* | [**list_providers_providers_get**](docs/DefaultApi.md#list_providers_providers_get) | **GET** /providers/ | List Providers
*DefaultApi* | [**list_providers_types_provider_types_get**](docs/DefaultApi.md#list_providers_types_provider_types_get) | **GET** /provider_types/ | List Providers Types
*DefaultApi* | [**login_token_post**](docs/DefaultApi.md#login_token_post) | **POST** /token | Login
*DefaultApi* | [**read_cluster_clusters_cluster_id_get**](docs/DefaultApi.md#read_cluster_clusters_cluster_id_get) | **GET** /clusters/{cluster_id} | Read Cluster
*DefaultApi* | [**read_job_instance_job_instances_job_instance_id_get**](docs/DefaultApi.md#read_job_instance_job_instances_job_instance_id_get) | **GET** /job_instances/{job_instance_id} | Read Job Instance
*DefaultApi* | [**read_log_logs_job_instance_id_get**](docs/DefaultApi.md#read_log_logs_job_instance_id_get) | **GET** /logs/{job_instance_id} | Read Log
*DefaultApi* | [**read_provider_providers_provider_id_get**](docs/DefaultApi.md#read_provider_providers_provider_id_get) | **GET** /providers/{provider_id} | Read Provider
*DefaultApi* | [**read_users_me_users_me_get**](docs/DefaultApi.md#read_users_me_users_me_get) | **GET** /users/me | Read Users Me
## Documentation For Models
- [ClientId](docs/ClientId.md)
- [ClientSecret](docs/ClientSecret.md)
- [ClusterIn](docs/ClusterIn.md)
- [GrantType](docs/GrantType.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [Id](docs/Id.md)
- [JobInstanceIn](docs/JobInstanceIn.md)
- [Provider](docs/Provider.md)
- [ValidationError](docs/ValidationError.md)
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="OAuth2PasswordBearer"></a>
### OAuth2PasswordBearer
- **Type**: OAuth
- **Flow**: password
- **Authorization URL**:
- **Scopes**: N/A
## Author
Raw data
{
"_id": null,
"home_page": null,
"name": "depot-api",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, FastAPI",
"author": null,
"author_email": "OpenAPI Generator Community <team@openapitools.org>, CodeDepot Team <contact@codedepot.ai>",
"download_url": "https://files.pythonhosted.org/packages/7b/66/f1944296ac561f961a46ac7ec6d4ca14325ddcc902f338b1a022d2455437/depot_api-1.0.4.tar.gz",
"platform": null,
"description": "# depot-api\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.1.0\n- Package version: 1.0.0\n- Generator version: 7.4.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport depot_api\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport depot_api\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport depot_api\nfrom depot_api.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = depot_api.Configuration(\n host = \"http://localhost\"\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\nconfiguration.access_token = os.environ[\"ACCESS_TOKEN\"]\n\n\n# Enter a context with an instance of the API client\nwith depot_api.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = depot_api.DefaultApi(api_client)\n cluster_in = depot_api.ClusterIn() # ClusterIn | \n\n try:\n # Create Cluster\n api_response = api_instance.create_cluster_clusters_post(cluster_in)\n print(\"The response of DefaultApi->create_cluster_clusters_post:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->create_cluster_clusters_post: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**create_cluster_clusters_post**](docs/DefaultApi.md#create_cluster_clusters_post) | **POST** /clusters/ | Create Cluster\n*DefaultApi* | [**create_job_instance_job_instances_post**](docs/DefaultApi.md#create_job_instance_job_instances_post) | **POST** /job_instances/ | Create Job Instance\n*DefaultApi* | [**create_provider_providers_post**](docs/DefaultApi.md#create_provider_providers_post) | **POST** /providers/ | Create Provider\n*DefaultApi* | [**delete_cluster_clusters_cluster_id_delete**](docs/DefaultApi.md#delete_cluster_clusters_cluster_id_delete) | **DELETE** /clusters/{cluster_id} | Delete Cluster\n*DefaultApi* | [**delete_job_instance_job_instances_job_instance_id_delete**](docs/DefaultApi.md#delete_job_instance_job_instances_job_instance_id_delete) | **DELETE** /job_instances/{job_instance_id} | Delete Job Instance\n*DefaultApi* | [**delete_provider_providers_provider_id_delete**](docs/DefaultApi.md#delete_provider_providers_provider_id_delete) | **DELETE** /providers/{provider_id} | Delete Provider\n*DefaultApi* | [**list_clusters_clusters_get**](docs/DefaultApi.md#list_clusters_clusters_get) | **GET** /clusters/ | List Clusters\n*DefaultApi* | [**list_job_instances_job_instances_get**](docs/DefaultApi.md#list_job_instances_job_instances_get) | **GET** /job_instances/ | List Job Instances\n*DefaultApi* | [**list_providers_providers_get**](docs/DefaultApi.md#list_providers_providers_get) | **GET** /providers/ | List Providers\n*DefaultApi* | [**list_providers_types_provider_types_get**](docs/DefaultApi.md#list_providers_types_provider_types_get) | **GET** /provider_types/ | List Providers Types\n*DefaultApi* | [**login_token_post**](docs/DefaultApi.md#login_token_post) | **POST** /token | Login\n*DefaultApi* | [**read_cluster_clusters_cluster_id_get**](docs/DefaultApi.md#read_cluster_clusters_cluster_id_get) | **GET** /clusters/{cluster_id} | Read Cluster\n*DefaultApi* | [**read_job_instance_job_instances_job_instance_id_get**](docs/DefaultApi.md#read_job_instance_job_instances_job_instance_id_get) | **GET** /job_instances/{job_instance_id} | Read Job Instance\n*DefaultApi* | [**read_log_logs_job_instance_id_get**](docs/DefaultApi.md#read_log_logs_job_instance_id_get) | **GET** /logs/{job_instance_id} | Read Log\n*DefaultApi* | [**read_provider_providers_provider_id_get**](docs/DefaultApi.md#read_provider_providers_provider_id_get) | **GET** /providers/{provider_id} | Read Provider\n*DefaultApi* | [**read_users_me_users_me_get**](docs/DefaultApi.md#read_users_me_users_me_get) | **GET** /users/me | Read Users Me\n\n\n## Documentation For Models\n\n - [ClientId](docs/ClientId.md)\n - [ClientSecret](docs/ClientSecret.md)\n - [ClusterIn](docs/ClusterIn.md)\n - [GrantType](docs/GrantType.md)\n - [HTTPValidationError](docs/HTTPValidationError.md)\n - [Id](docs/Id.md)\n - [JobInstanceIn](docs/JobInstanceIn.md)\n - [Provider](docs/Provider.md)\n - [ValidationError](docs/ValidationError.md)\n - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"OAuth2PasswordBearer\"></a>\n### OAuth2PasswordBearer\n\n- **Type**: OAuth\n- **Flow**: password\n- **Authorization URL**: \n- **Scopes**: N/A\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "FastAPI client for the Depot API",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://codedepot.ai",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" fastapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58231067d38f4e9c8b0fc34da4edd4bf9b7be06d3abfc8c5f0b030e06b404237",
"md5": "8f2b2c3d2d4f060c194a118b398ef860",
"sha256": "1891c3caf51668ef6e40eeeb1c670f8e36ea396d615bd8d9fd5dea4117526080"
},
"downloads": -1,
"filename": "depot_api-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f2b2c3d2d4f060c194a118b398ef860",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 55685,
"upload_time": "2024-04-19T12:46:11",
"upload_time_iso_8601": "2024-04-19T12:46:11.112468Z",
"url": "https://files.pythonhosted.org/packages/58/23/1067d38f4e9c8b0fc34da4edd4bf9b7be06d3abfc8c5f0b030e06b404237/depot_api-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7b66f1944296ac561f961a46ac7ec6d4ca14325ddcc902f338b1a022d2455437",
"md5": "c3e2c9a0a325eb7dacc03f5860e257f3",
"sha256": "e056d5144f502272610e9ff5118d32b7041e7d01b80f07a393bb7b4e24339ab7"
},
"downloads": -1,
"filename": "depot_api-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "c3e2c9a0a325eb7dacc03f5860e257f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 29410,
"upload_time": "2024-04-19T12:46:13",
"upload_time_iso_8601": "2024-04-19T12:46:13.454767Z",
"url": "https://files.pythonhosted.org/packages/7b/66/f1944296ac561f961a46ac7ec6d4ca14325ddcc902f338b1a022d2455437/depot_api-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-19 12:46:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "depot-api"
}
JSON
