# Nuvolos Client 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: prod
- Package version: 1.0.2
- 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 nuvolos_client_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 nuvolos_client_api
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import nuvolos_client_api
from nuvolos_client_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 = nuvolos_client_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.
# 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 nuvolos_client_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = nuvolos_client_api.AppsV1Api(api_client)
org_slug = 'org_slug_example' # str |
instance_slug = 'instance_slug_example' # str |
space_slug = 'space_slug_example' # str |
snapshot_slug = 'snapshot_slug_example' # str |
try:
api_response = api_instance.get_apps(org_slug, instance_slug, space_slug, snapshot_slug)
print("The response of AppsV1Api->get_apps:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AppsV1Api->get_apps: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AppsV1Api* | [**get_apps**](docs/AppsV1Api.md#get_apps) | **GET** /apps/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug} |
*InstancesV1Api* | [**get_instances**](docs/InstancesV1Api.md#get_instances) | **GET** /instances/v1/org/{org_slug}/space/{space_slug} |
*OrganizationsV1Api* | [**get_orgs**](docs/OrganizationsV1Api.md#get_orgs) | **GET** /orgs/v1 |
*SnapshotsV1Api* | [**get_snapshots**](docs/SnapshotsV1Api.md#get_snapshots) | **GET** /snapshots/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug} |
*SpacesV1Api* | [**get_spaces**](docs/SpacesV1Api.md#get_spaces) | **GET** /spaces/v1/org/{slug} |
*WorkloadsV1Api* | [**create_workload**](docs/WorkloadsV1Api.md#create_workload) | **POST** /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug} |
*WorkloadsV1Api* | [**delete_workload**](docs/WorkloadsV1Api.md#delete_workload) | **DELETE** /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug} |
*WorkloadsV1Api* | [**execute_command**](docs/WorkloadsV1Api.md#execute_command) | **POST** /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug}/execute |
*WorkloadsV1Api* | [**get_nodepools**](docs/WorkloadsV1Api.md#get_nodepools) | **GET** /workloads/v1/nodepools |
*WorkloadsV1Api* | [**get_workloads**](docs/WorkloadsV1Api.md#get_workloads) | **GET** /workloads/v1 |
*WorkloadsV1Api* | [**get_workloads_for_app**](docs/WorkloadsV1Api.md#get_workloads_for_app) | **GET** /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug} |
## Documentation For Models
- [APINodePool](docs/APINodePool.md)
- [Application](docs/Application.md)
- [ClientApiError](docs/ClientApiError.md)
- [ExecuteCommand](docs/ExecuteCommand.md)
- [ExecuteCommandResponse](docs/ExecuteCommandResponse.md)
- [Instance](docs/Instance.md)
- [Org](docs/Org.md)
- [Snapshot](docs/Snapshot.md)
- [Space](docs/Space.md)
- [StartApp](docs/StartApp.md)
- [Task](docs/Task.md)
- [WorkloadDetailed](docs/WorkloadDetailed.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/nuvolos-cloud/nuvolos-client-api",
"name": "nuvolos-client-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,Nuvolos",
"author": "Alphacruncher",
"author_email": "support@nuvolos.cloud",
"download_url": "https://files.pythonhosted.org/packages/64/60/710a11c001fa7db0785901fbd184671d22c137d14137a37acc724878942c/nuvolos_client_api-1.0.2.tar.gz",
"platform": null,
"description": "# Nuvolos Client 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: prod\n- Package version: 1.0.2\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 nuvolos_client_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 nuvolos_client_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 time\nimport nuvolos_client_api\nfrom nuvolos_client_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 = nuvolos_client_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\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 nuvolos_client_api.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = nuvolos_client_api.AppsV1Api(api_client)\n org_slug = 'org_slug_example' # str | \n instance_slug = 'instance_slug_example' # str | \n space_slug = 'space_slug_example' # str | \n snapshot_slug = 'snapshot_slug_example' # str | \n\n try:\n api_response = api_instance.get_apps(org_slug, instance_slug, space_slug, snapshot_slug)\n print(\"The response of AppsV1Api->get_apps:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling AppsV1Api->get_apps: %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*AppsV1Api* | [**get_apps**](docs/AppsV1Api.md#get_apps) | **GET** /apps/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/snapshot/{snapshot_slug} | \n*InstancesV1Api* | [**get_instances**](docs/InstancesV1Api.md#get_instances) | **GET** /instances/v1/org/{org_slug}/space/{space_slug} | \n*OrganizationsV1Api* | [**get_orgs**](docs/OrganizationsV1Api.md#get_orgs) | **GET** /orgs/v1 | \n*SnapshotsV1Api* | [**get_snapshots**](docs/SnapshotsV1Api.md#get_snapshots) | **GET** /snapshots/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug} | \n*SpacesV1Api* | [**get_spaces**](docs/SpacesV1Api.md#get_spaces) | **GET** /spaces/v1/org/{slug} | \n*WorkloadsV1Api* | [**create_workload**](docs/WorkloadsV1Api.md#create_workload) | **POST** /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug} | \n*WorkloadsV1Api* | [**delete_workload**](docs/WorkloadsV1Api.md#delete_workload) | **DELETE** /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug} | \n*WorkloadsV1Api* | [**execute_command**](docs/WorkloadsV1Api.md#execute_command) | **POST** /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug}/execute | \n*WorkloadsV1Api* | [**get_nodepools**](docs/WorkloadsV1Api.md#get_nodepools) | **GET** /workloads/v1/nodepools | \n*WorkloadsV1Api* | [**get_workloads**](docs/WorkloadsV1Api.md#get_workloads) | **GET** /workloads/v1 | \n*WorkloadsV1Api* | [**get_workloads_for_app**](docs/WorkloadsV1Api.md#get_workloads_for_app) | **GET** /workloads/v1/org/{org_slug}/space/{space_slug}/instance/{instance_slug}/app/{app_slug} | \n\n\n## Documentation For Models\n\n - [APINodePool](docs/APINodePool.md)\n - [Application](docs/Application.md)\n - [ClientApiError](docs/ClientApiError.md)\n - [ExecuteCommand](docs/ExecuteCommand.md)\n - [ExecuteCommandResponse](docs/ExecuteCommandResponse.md)\n - [Instance](docs/Instance.md)\n - [Org](docs/Org.md)\n - [Snapshot](docs/Snapshot.md)\n - [Space](docs/Space.md)\n - [StartApp](docs/StartApp.md)\n - [Task](docs/Task.md)\n - [WorkloadDetailed](docs/WorkloadDetailed.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=\"ApiKeyAuth\"></a>\n### ApiKeyAuth\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n\n\n## Author\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "Nuvolos",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/nuvolos-cloud/nuvolos-client-api",
"Repository": "https://github.com/nuvolos-cloud/nuvolos-client-api"
},
"split_keywords": [
"openapi",
"openapi-generator",
"nuvolos"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c147a442ab18585caf69aad62defd2d2472dc437f23f1de18a92dc05ccd26b43",
"md5": "0b71020755f4096561278997dba1708b",
"sha256": "498d8d7d4076d201e81c1f6b6bb0ae3238d15e997047d9e9c6d65ef304e47eec"
},
"downloads": -1,
"filename": "nuvolos_client_api-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b71020755f4096561278997dba1708b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 48811,
"upload_time": "2024-02-09T10:52:38",
"upload_time_iso_8601": "2024-02-09T10:52:38.121027Z",
"url": "https://files.pythonhosted.org/packages/c1/47/a442ab18585caf69aad62defd2d2472dc437f23f1de18a92dc05ccd26b43/nuvolos_client_api-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6460710a11c001fa7db0785901fbd184671d22c137d14137a37acc724878942c",
"md5": "88e03a97a4240a65f961f0ff767aa0fe",
"sha256": "cfdeed5346830aeda8ec17454ede125fd5333a920d818a1eafd6d5e6e2307628"
},
"downloads": -1,
"filename": "nuvolos_client_api-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "88e03a97a4240a65f961f0ff767aa0fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 25067,
"upload_time": "2024-02-09T10:52:39",
"upload_time_iso_8601": "2024-02-09T10:52:39.822724Z",
"url": "https://files.pythonhosted.org/packages/64/60/710a11c001fa7db0785901fbd184671d22c137d14137a37acc724878942c/nuvolos_client_api-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-09 10:52:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nuvolos-cloud",
"github_project": "nuvolos-client-api",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "python_dateutil",
"specs": [
[
">=",
"2.5.3"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"21.0.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
"<",
"2.1.0"
],
[
">=",
"1.25.3"
]
]
},
{
"name": "pydantic",
"specs": [
[
">=",
"2"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
">=",
"4.7.1"
]
]
}
],
"tox": true,
"lcname": "nuvolos-client-api"
}
JSON
