# Cirro API Client
Cirro Data Platform service API
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
## 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/CirroBio/Cirro-client-python.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/CirroBio/Cirro-client-python.git`)
Then import the package:
```python
import cirro_api_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 cirro_api_client
```
### 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 cirro_api_client
from cirro_api_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.cirro.bio
# See configuration.py for a list of all supported configuration parameters.
configuration = cirro_api_client.Configuration(
host = "https://api.cirro.bio"
)
# 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 Bearer authorization (JWT): accessToken
configuration = cirro_api_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with cirro_api_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = cirro_api_client.BillingApi(api_client)
billing_account_request = cirro_api_client.BillingAccountRequest() # BillingAccountRequest |
try:
# Create billing account
api_response = api_instance.create_billing_account(billing_account_request)
print("The response of BillingApi->create_billing_account:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling BillingApi->create_billing_account: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.cirro.bio*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BillingApi* | [**create_billing_account**](docs/BillingApi.md#create_billing_account) | **POST** /billing | Create billing account
*BillingApi* | [**delete_billing_account**](docs/BillingApi.md#delete_billing_account) | **DELETE** /billing/{billingAccountId} | Delete billing account
*BillingApi* | [**generate_billing_report**](docs/BillingApi.md#generate_billing_report) | **GET** /billing-report | Generate billing report
*BillingApi* | [**get_billing_accounts**](docs/BillingApi.md#get_billing_accounts) | **GET** /billing | List billing accounts
*BillingApi* | [**update_billing_account**](docs/BillingApi.md#update_billing_account) | **PUT** /billing/{billingAccountId} | Update billing account
*DashboardsApi* | [**create_dashboard**](docs/DashboardsApi.md#create_dashboard) | **POST** /projects/{projectId}/dashboards | Create dashboard
*DashboardsApi* | [**delete_dashboard**](docs/DashboardsApi.md#delete_dashboard) | **DELETE** /projects/{projectId}/dashboards/{dashboardId} | Delete dashboard
*DashboardsApi* | [**get_dashboard**](docs/DashboardsApi.md#get_dashboard) | **GET** /projects/{projectId}/dashboards/{dashboardId} | Get dashboard
*DashboardsApi* | [**get_dashboards**](docs/DashboardsApi.md#get_dashboards) | **GET** /projects/{projectId}/dashboards | List dashboards
*DashboardsApi* | [**update_dashboard**](docs/DashboardsApi.md#update_dashboard) | **PUT** /projects/{projectId}/dashboards/{dashboardId} | Update dashboard
*DatasetsApi* | [**delete_dataset**](docs/DatasetsApi.md#delete_dataset) | **DELETE** /projects/{projectId}/datasets/{datasetId} | Delete a dataset
*DatasetsApi* | [**get_dataset**](docs/DatasetsApi.md#get_dataset) | **GET** /projects/{projectId}/datasets/{datasetId} | Get dataset
*DatasetsApi* | [**get_dataset_manifest**](docs/DatasetsApi.md#get_dataset_manifest) | **GET** /projects/{projectId}/datasets/{datasetId}/files | Get dataset manifest
*DatasetsApi* | [**get_datasets**](docs/DatasetsApi.md#get_datasets) | **GET** /projects/{projectId}/datasets | List datasets
*DatasetsApi* | [**import_public_dataset**](docs/DatasetsApi.md#import_public_dataset) | **POST** /projects/{projectId}/datasets/import | Import public dataset
*DatasetsApi* | [**ingest_samples**](docs/DatasetsApi.md#ingest_samples) | **PUT** /projects/{projectId}/datasets/{datasetId}/ingest-samples | Rerun sample ingest
*DatasetsApi* | [**regenerate_manifest**](docs/DatasetsApi.md#regenerate_manifest) | **PUT** /projects/{projectId}/datasets/{datasetId}/regenerate-manifest | Regenerate dataset manifest
*DatasetsApi* | [**rerun_transform**](docs/DatasetsApi.md#rerun_transform) | **PUT** /projects/{projectId}/datasets/{datasetId}/rerun-transform | Rerun data transforms
*DatasetsApi* | [**update_dataset**](docs/DatasetsApi.md#update_dataset) | **PUT** /projects/{projectId}/datasets/{datasetId} | Update dataset
*DatasetsApi* | [**upload_dataset**](docs/DatasetsApi.md#upload_dataset) | **POST** /projects/{projectId}/datasets/upload | Upload private dataset
*ExecutionApi* | [**get_execution_logs**](docs/ExecutionApi.md#get_execution_logs) | **GET** /projects/{projectId}/execution/{datasetId}/logs | Get execution logs
*ExecutionApi* | [**get_project_summary**](docs/ExecutionApi.md#get_project_summary) | **GET** /projects/{projectId}/execution | Get execution summary
*ExecutionApi* | [**get_task_logs**](docs/ExecutionApi.md#get_task_logs) | **GET** /projects/{projectId}/execution/{datasetId}/tasks/{taskId}/logs | Get task logs
*ExecutionApi* | [**get_tasks_for_execution**](docs/ExecutionApi.md#get_tasks_for_execution) | **GET** /projects/{projectId}/execution/{datasetId}/tasks | Get execution tasks
*ExecutionApi* | [**run_analysis**](docs/ExecutionApi.md#run_analysis) | **POST** /projects/{projectId}/execution | Run analysis
*ExecutionApi* | [**stop_analysis**](docs/ExecutionApi.md#stop_analysis) | **PUT** /projects/{projectId}/execution/{datasetId}/stop | Stop execution
*FileApi* | [**generate_project_file_access_token**](docs/FileApi.md#generate_project_file_access_token) | **POST** /projects/{projectId}/s3-token | Create project file access token
*FileApi* | [**generate_project_sftp_token**](docs/FileApi.md#generate_project_sftp_token) | **POST** /projects/{projectId}/sftp-token | Create project SFTP Token
*MetadataApi* | [**get_project_samples**](docs/MetadataApi.md#get_project_samples) | **GET** /projects/{projectId}/samples | Get project samples
*MetadataApi* | [**get_project_schema**](docs/MetadataApi.md#get_project_schema) | **GET** /projects/{projectId}/schema | Get project metadata schema
*MetadataApi* | [**update_project_schema**](docs/MetadataApi.md#update_project_schema) | **PUT** /projects/{projectId}/schema | Update project metadata schema
*MetadataApi* | [**update_sample**](docs/MetadataApi.md#update_sample) | **PUT** /projects/{projectId}/samples/{sampleId} | Update sample
*MetricsApi* | [**get_all_metrics**](docs/MetricsApi.md#get_all_metrics) | **GET** /metrics | Get all project metrics
*MetricsApi* | [**get_project_metrics**](docs/MetricsApi.md#get_project_metrics) | **GET** /projects/{projectId}/metrics | Get project metrics
*NotebooksApi* | [**create_notebook_instance**](docs/NotebooksApi.md#create_notebook_instance) | **POST** /projects/{projectId}/notebook-instances | Create notebook instance
*NotebooksApi* | [**delete_notebook_instance**](docs/NotebooksApi.md#delete_notebook_instance) | **DELETE** /projects/{projectId}/notebook-instances/{notebookInstanceId} | Delete notebook instance
*NotebooksApi* | [**generate_notebook_instance_url**](docs/NotebooksApi.md#generate_notebook_instance_url) | **GET** /projects/{projectId}/notebook-instances/{notebookInstanceId}:generate-url | Generate notebook instance URL
*NotebooksApi* | [**get_notebook_instance_status**](docs/NotebooksApi.md#get_notebook_instance_status) | **GET** /projects/{projectId}/notebook-instances/{notebookInstanceId}:status | Get notebook instance status
*NotebooksApi* | [**get_notebook_instances**](docs/NotebooksApi.md#get_notebook_instances) | **GET** /projects/{projectId}/notebook-instances | Get notebook instances
*NotebooksApi* | [**stop_notebook_instance**](docs/NotebooksApi.md#stop_notebook_instance) | **POST** /projects/{projectId}/notebook-instances/{notebookInstanceId}:stop | Stop notebook instance
*ProcessesApi* | [**archive_custom_process**](docs/ProcessesApi.md#archive_custom_process) | **DELETE** /processes/{processId} | Archive custom process
*ProcessesApi* | [**create_custom_process**](docs/ProcessesApi.md#create_custom_process) | **POST** /processes | Create custom process
*ProcessesApi* | [**get_process**](docs/ProcessesApi.md#get_process) | **GET** /processes/{processId} | Get process
*ProcessesApi* | [**get_process_parameters**](docs/ProcessesApi.md#get_process_parameters) | **GET** /processes/{processId}/parameters | Get process parameters
*ProcessesApi* | [**get_processes**](docs/ProcessesApi.md#get_processes) | **GET** /processes | List processes
*ProcessesApi* | [**sync_custom_process**](docs/ProcessesApi.md#sync_custom_process) | **PUT** /processes/{processId}:sync | Sync custom process
*ProcessesApi* | [**update_custom_process**](docs/ProcessesApi.md#update_custom_process) | **PUT** /processes/{processId} | Update custom process
*ProcessesApi* | [**validate_file_requirements**](docs/ProcessesApi.md#validate_file_requirements) | **POST** /processes/{processId}/validate-files | Validate file requirements
*ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /projects | Create project
*ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /projects/{projectId} | Get project
*ProjectsApi* | [**get_project_users**](docs/ProjectsApi.md#get_project_users) | **GET** /projects/{projectId}/permissions | Get project permissions
*ProjectsApi* | [**get_projects**](docs/ProjectsApi.md#get_projects) | **GET** /projects | Get projects
*ProjectsApi* | [**redeploy_project**](docs/ProjectsApi.md#redeploy_project) | **PUT** /projects/{projectId}:re-deploy | Redeploy project
*ProjectsApi* | [**set_user_project_role**](docs/ProjectsApi.md#set_user_project_role) | **PUT** /projects/{projectId}/permissions | Set role
*ProjectsApi* | [**update_project**](docs/ProjectsApi.md#update_project) | **PUT** /projects/{projectId} | Update project
*ProjectsApi* | [**update_project_tags**](docs/ProjectsApi.md#update_project_tags) | **PUT** /projects/{projectId}:tags | Set project tags
*ReferencesApi* | [**create_project_reference**](docs/ReferencesApi.md#create_project_reference) | **POST** /projects/{projectId}/references | Create project reference
*ReferencesApi* | [**delete_project_reference**](docs/ReferencesApi.md#delete_project_reference) | **DELETE** /projects/{projectId}/references | Delete project reference
*ReferencesApi* | [**get_reference_types**](docs/ReferencesApi.md#get_reference_types) | **GET** /reference-types | Get reference types
*ReferencesApi* | [**get_references**](docs/ReferencesApi.md#get_references) | **GET** /references | Get global references
*ReferencesApi* | [**get_references_for_project**](docs/ReferencesApi.md#get_references_for_project) | **GET** /projects/{projectId}/references | Get project references
*ReferencesApi* | [**refresh_project_references**](docs/ReferencesApi.md#refresh_project_references) | **PUT** /projects/{projectId}/references | Refresh project references
*SystemApi* | [**get_service_connections**](docs/SystemApi.md#get_service_connections) | **GET** /service-connections | Get service connections
*SystemApi* | [**info**](docs/SystemApi.md#info) | **GET** /info | Get system info
*UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /users/{username} | Get user
*UsersApi* | [**get_users**](docs/UsersApi.md#get_users) | **GET** /users | List users
*UsersApi* | [**invite_user**](docs/UsersApi.md#invite_user) | **POST** /users | Invite user
*UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PUT** /users/{username} | Update user
## Documentation For Models
- [AWSCredentials](docs/AWSCredentials.md)
- [AccessType](docs/AccessType.md)
- [AllowedDataType](docs/AllowedDataType.md)
- [BillingAccount](docs/BillingAccount.md)
- [BillingAccountRequest](docs/BillingAccountRequest.md)
- [BillingMethod](docs/BillingMethod.md)
- [BudgetPeriod](docs/BudgetPeriod.md)
- [CloudAccount](docs/CloudAccount.md)
- [Contact](docs/Contact.md)
- [CreateNotebookInstanceRequest](docs/CreateNotebookInstanceRequest.md)
- [CreateReferenceRequest](docs/CreateReferenceRequest.md)
- [CreateResponse](docs/CreateResponse.md)
- [CustomPipelineSettings](docs/CustomPipelineSettings.md)
- [CustomerType](docs/CustomerType.md)
- [Dashboard](docs/Dashboard.md)
- [DashboardRequest](docs/DashboardRequest.md)
- [Dataset](docs/Dataset.md)
- [DatasetAssetsManifest](docs/DatasetAssetsManifest.md)
- [DatasetDetail](docs/DatasetDetail.md)
- [DatasetViz](docs/DatasetViz.md)
- [ErrorMessage](docs/ErrorMessage.md)
- [Executor](docs/Executor.md)
- [FileAccessRequest](docs/FileAccessRequest.md)
- [FileEntry](docs/FileEntry.md)
- [FileNamePattern](docs/FileNamePattern.md)
- [FileRequirements](docs/FileRequirements.md)
- [FormSchema](docs/FormSchema.md)
- [GenerateSftpCredentialsRequest](docs/GenerateSftpCredentialsRequest.md)
- [GetExecutionLogsResponse](docs/GetExecutionLogsResponse.md)
- [ImportDataRequest](docs/ImportDataRequest.md)
- [InviteUserRequest](docs/InviteUserRequest.md)
- [InviteUserResponse](docs/InviteUserResponse.md)
- [LogEntry](docs/LogEntry.md)
- [MetricRecord](docs/MetricRecord.md)
- [NotebookInstance](docs/NotebookInstance.md)
- [NotebookInstanceStatusResponse](docs/NotebookInstanceStatusResponse.md)
- [OpenNotebookInstanceResponse](docs/OpenNotebookInstanceResponse.md)
- [PaginatedResponseDatasetListDto](docs/PaginatedResponseDatasetListDto.md)
- [PaginatedResponseSampleDto](docs/PaginatedResponseSampleDto.md)
- [PipelineCode](docs/PipelineCode.md)
- [PortalErrorResponse](docs/PortalErrorResponse.md)
- [Process](docs/Process.md)
- [ProcessDetail](docs/ProcessDetail.md)
- [ProcessDetailAllOfPipelineCode](docs/ProcessDetailAllOfPipelineCode.md)
- [Project](docs/Project.md)
- [ProjectDetail](docs/ProjectDetail.md)
- [ProjectMetrics](docs/ProjectMetrics.md)
- [ProjectRequest](docs/ProjectRequest.md)
- [ProjectRole](docs/ProjectRole.md)
- [ProjectSettings](docs/ProjectSettings.md)
- [ProjectUser](docs/ProjectUser.md)
- [Reference](docs/Reference.md)
- [ReferenceType](docs/ReferenceType.md)
- [RepositoryType](docs/RepositoryType.md)
- [ResourcesInfo](docs/ResourcesInfo.md)
- [RunAnalysisRequest](docs/RunAnalysisRequest.md)
- [Sample](docs/Sample.md)
- [SampleRequest](docs/SampleRequest.md)
- [ServiceConnection](docs/ServiceConnection.md)
- [SetUserProjectRoleRequest](docs/SetUserProjectRoleRequest.md)
- [SftpCredentials](docs/SftpCredentials.md)
- [Status](docs/Status.md)
- [StopExecutionResponse](docs/StopExecutionResponse.md)
- [SyncStatus](docs/SyncStatus.md)
- [SystemInfoResponse](docs/SystemInfoResponse.md)
- [Tag](docs/Tag.md)
- [Task](docs/Task.md)
- [UpdateDatasetRequest](docs/UpdateDatasetRequest.md)
- [UpdateUserRequest](docs/UpdateUserRequest.md)
- [UploadDatasetCreateResponse](docs/UploadDatasetCreateResponse.md)
- [UploadDatasetRequest](docs/UploadDatasetRequest.md)
- [User](docs/User.md)
- [ValidateFileRequirementsRequest](docs/ValidateFileRequirementsRequest.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="accessToken"></a>
### accessToken
- **Type**: Bearer authentication (JWT)
## Author
support@cirro.bio
Raw data
{
"_id": null,
"home_page": "https://github.com/CirroBio/Cirro-client-python",
"name": "cirro-api-client",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,Cirro Data",
"author": "Cirro",
"author_email": "support@cirro.bio",
"download_url": "https://files.pythonhosted.org/packages/c7/17/58361b0b875cc20d39ceae60ca12d3b0386694efeb37ef66dc93d8f62dab/cirro_api_client-0.0.1a0.tar.gz",
"platform": null,
"description": "# Cirro API Client\nCirro Data Platform service API\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\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/CirroBio/Cirro-client-python.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/CirroBio/Cirro-client-python.git`)\n\nThen import the package:\n```python\nimport cirro_api_client\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 cirro_api_client\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 cirro_api_client\nfrom cirro_api_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://api.cirro.bio\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = cirro_api_client.Configuration(\n host = \"https://api.cirro.bio\"\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 Bearer authorization (JWT): accessToken\nconfiguration = cirro_api_client.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith cirro_api_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = cirro_api_client.BillingApi(api_client)\n billing_account_request = cirro_api_client.BillingAccountRequest() # BillingAccountRequest | \n\n try:\n # Create billing account\n api_response = api_instance.create_billing_account(billing_account_request)\n print(\"The response of BillingApi->create_billing_account:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling BillingApi->create_billing_account: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.cirro.bio*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BillingApi* | [**create_billing_account**](docs/BillingApi.md#create_billing_account) | **POST** /billing | Create billing account\n*BillingApi* | [**delete_billing_account**](docs/BillingApi.md#delete_billing_account) | **DELETE** /billing/{billingAccountId} | Delete billing account\n*BillingApi* | [**generate_billing_report**](docs/BillingApi.md#generate_billing_report) | **GET** /billing-report | Generate billing report\n*BillingApi* | [**get_billing_accounts**](docs/BillingApi.md#get_billing_accounts) | **GET** /billing | List billing accounts\n*BillingApi* | [**update_billing_account**](docs/BillingApi.md#update_billing_account) | **PUT** /billing/{billingAccountId} | Update billing account\n*DashboardsApi* | [**create_dashboard**](docs/DashboardsApi.md#create_dashboard) | **POST** /projects/{projectId}/dashboards | Create dashboard\n*DashboardsApi* | [**delete_dashboard**](docs/DashboardsApi.md#delete_dashboard) | **DELETE** /projects/{projectId}/dashboards/{dashboardId} | Delete dashboard\n*DashboardsApi* | [**get_dashboard**](docs/DashboardsApi.md#get_dashboard) | **GET** /projects/{projectId}/dashboards/{dashboardId} | Get dashboard\n*DashboardsApi* | [**get_dashboards**](docs/DashboardsApi.md#get_dashboards) | **GET** /projects/{projectId}/dashboards | List dashboards\n*DashboardsApi* | [**update_dashboard**](docs/DashboardsApi.md#update_dashboard) | **PUT** /projects/{projectId}/dashboards/{dashboardId} | Update dashboard\n*DatasetsApi* | [**delete_dataset**](docs/DatasetsApi.md#delete_dataset) | **DELETE** /projects/{projectId}/datasets/{datasetId} | Delete a dataset\n*DatasetsApi* | [**get_dataset**](docs/DatasetsApi.md#get_dataset) | **GET** /projects/{projectId}/datasets/{datasetId} | Get dataset\n*DatasetsApi* | [**get_dataset_manifest**](docs/DatasetsApi.md#get_dataset_manifest) | **GET** /projects/{projectId}/datasets/{datasetId}/files | Get dataset manifest\n*DatasetsApi* | [**get_datasets**](docs/DatasetsApi.md#get_datasets) | **GET** /projects/{projectId}/datasets | List datasets\n*DatasetsApi* | [**import_public_dataset**](docs/DatasetsApi.md#import_public_dataset) | **POST** /projects/{projectId}/datasets/import | Import public dataset\n*DatasetsApi* | [**ingest_samples**](docs/DatasetsApi.md#ingest_samples) | **PUT** /projects/{projectId}/datasets/{datasetId}/ingest-samples | Rerun sample ingest\n*DatasetsApi* | [**regenerate_manifest**](docs/DatasetsApi.md#regenerate_manifest) | **PUT** /projects/{projectId}/datasets/{datasetId}/regenerate-manifest | Regenerate dataset manifest\n*DatasetsApi* | [**rerun_transform**](docs/DatasetsApi.md#rerun_transform) | **PUT** /projects/{projectId}/datasets/{datasetId}/rerun-transform | Rerun data transforms\n*DatasetsApi* | [**update_dataset**](docs/DatasetsApi.md#update_dataset) | **PUT** /projects/{projectId}/datasets/{datasetId} | Update dataset\n*DatasetsApi* | [**upload_dataset**](docs/DatasetsApi.md#upload_dataset) | **POST** /projects/{projectId}/datasets/upload | Upload private dataset\n*ExecutionApi* | [**get_execution_logs**](docs/ExecutionApi.md#get_execution_logs) | **GET** /projects/{projectId}/execution/{datasetId}/logs | Get execution logs\n*ExecutionApi* | [**get_project_summary**](docs/ExecutionApi.md#get_project_summary) | **GET** /projects/{projectId}/execution | Get execution summary\n*ExecutionApi* | [**get_task_logs**](docs/ExecutionApi.md#get_task_logs) | **GET** /projects/{projectId}/execution/{datasetId}/tasks/{taskId}/logs | Get task logs\n*ExecutionApi* | [**get_tasks_for_execution**](docs/ExecutionApi.md#get_tasks_for_execution) | **GET** /projects/{projectId}/execution/{datasetId}/tasks | Get execution tasks\n*ExecutionApi* | [**run_analysis**](docs/ExecutionApi.md#run_analysis) | **POST** /projects/{projectId}/execution | Run analysis\n*ExecutionApi* | [**stop_analysis**](docs/ExecutionApi.md#stop_analysis) | **PUT** /projects/{projectId}/execution/{datasetId}/stop | Stop execution\n*FileApi* | [**generate_project_file_access_token**](docs/FileApi.md#generate_project_file_access_token) | **POST** /projects/{projectId}/s3-token | Create project file access token\n*FileApi* | [**generate_project_sftp_token**](docs/FileApi.md#generate_project_sftp_token) | **POST** /projects/{projectId}/sftp-token | Create project SFTP Token\n*MetadataApi* | [**get_project_samples**](docs/MetadataApi.md#get_project_samples) | **GET** /projects/{projectId}/samples | Get project samples\n*MetadataApi* | [**get_project_schema**](docs/MetadataApi.md#get_project_schema) | **GET** /projects/{projectId}/schema | Get project metadata schema\n*MetadataApi* | [**update_project_schema**](docs/MetadataApi.md#update_project_schema) | **PUT** /projects/{projectId}/schema | Update project metadata schema\n*MetadataApi* | [**update_sample**](docs/MetadataApi.md#update_sample) | **PUT** /projects/{projectId}/samples/{sampleId} | Update sample\n*MetricsApi* | [**get_all_metrics**](docs/MetricsApi.md#get_all_metrics) | **GET** /metrics | Get all project metrics\n*MetricsApi* | [**get_project_metrics**](docs/MetricsApi.md#get_project_metrics) | **GET** /projects/{projectId}/metrics | Get project metrics\n*NotebooksApi* | [**create_notebook_instance**](docs/NotebooksApi.md#create_notebook_instance) | **POST** /projects/{projectId}/notebook-instances | Create notebook instance\n*NotebooksApi* | [**delete_notebook_instance**](docs/NotebooksApi.md#delete_notebook_instance) | **DELETE** /projects/{projectId}/notebook-instances/{notebookInstanceId} | Delete notebook instance\n*NotebooksApi* | [**generate_notebook_instance_url**](docs/NotebooksApi.md#generate_notebook_instance_url) | **GET** /projects/{projectId}/notebook-instances/{notebookInstanceId}:generate-url | Generate notebook instance URL\n*NotebooksApi* | [**get_notebook_instance_status**](docs/NotebooksApi.md#get_notebook_instance_status) | **GET** /projects/{projectId}/notebook-instances/{notebookInstanceId}:status | Get notebook instance status\n*NotebooksApi* | [**get_notebook_instances**](docs/NotebooksApi.md#get_notebook_instances) | **GET** /projects/{projectId}/notebook-instances | Get notebook instances\n*NotebooksApi* | [**stop_notebook_instance**](docs/NotebooksApi.md#stop_notebook_instance) | **POST** /projects/{projectId}/notebook-instances/{notebookInstanceId}:stop | Stop notebook instance\n*ProcessesApi* | [**archive_custom_process**](docs/ProcessesApi.md#archive_custom_process) | **DELETE** /processes/{processId} | Archive custom process\n*ProcessesApi* | [**create_custom_process**](docs/ProcessesApi.md#create_custom_process) | **POST** /processes | Create custom process\n*ProcessesApi* | [**get_process**](docs/ProcessesApi.md#get_process) | **GET** /processes/{processId} | Get process\n*ProcessesApi* | [**get_process_parameters**](docs/ProcessesApi.md#get_process_parameters) | **GET** /processes/{processId}/parameters | Get process parameters\n*ProcessesApi* | [**get_processes**](docs/ProcessesApi.md#get_processes) | **GET** /processes | List processes\n*ProcessesApi* | [**sync_custom_process**](docs/ProcessesApi.md#sync_custom_process) | **PUT** /processes/{processId}:sync | Sync custom process\n*ProcessesApi* | [**update_custom_process**](docs/ProcessesApi.md#update_custom_process) | **PUT** /processes/{processId} | Update custom process\n*ProcessesApi* | [**validate_file_requirements**](docs/ProcessesApi.md#validate_file_requirements) | **POST** /processes/{processId}/validate-files | Validate file requirements\n*ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /projects | Create project\n*ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /projects/{projectId} | Get project\n*ProjectsApi* | [**get_project_users**](docs/ProjectsApi.md#get_project_users) | **GET** /projects/{projectId}/permissions | Get project permissions\n*ProjectsApi* | [**get_projects**](docs/ProjectsApi.md#get_projects) | **GET** /projects | Get projects\n*ProjectsApi* | [**redeploy_project**](docs/ProjectsApi.md#redeploy_project) | **PUT** /projects/{projectId}:re-deploy | Redeploy project\n*ProjectsApi* | [**set_user_project_role**](docs/ProjectsApi.md#set_user_project_role) | **PUT** /projects/{projectId}/permissions | Set role\n*ProjectsApi* | [**update_project**](docs/ProjectsApi.md#update_project) | **PUT** /projects/{projectId} | Update project\n*ProjectsApi* | [**update_project_tags**](docs/ProjectsApi.md#update_project_tags) | **PUT** /projects/{projectId}:tags | Set project tags\n*ReferencesApi* | [**create_project_reference**](docs/ReferencesApi.md#create_project_reference) | **POST** /projects/{projectId}/references | Create project reference\n*ReferencesApi* | [**delete_project_reference**](docs/ReferencesApi.md#delete_project_reference) | **DELETE** /projects/{projectId}/references | Delete project reference\n*ReferencesApi* | [**get_reference_types**](docs/ReferencesApi.md#get_reference_types) | **GET** /reference-types | Get reference types\n*ReferencesApi* | [**get_references**](docs/ReferencesApi.md#get_references) | **GET** /references | Get global references\n*ReferencesApi* | [**get_references_for_project**](docs/ReferencesApi.md#get_references_for_project) | **GET** /projects/{projectId}/references | Get project references\n*ReferencesApi* | [**refresh_project_references**](docs/ReferencesApi.md#refresh_project_references) | **PUT** /projects/{projectId}/references | Refresh project references\n*SystemApi* | [**get_service_connections**](docs/SystemApi.md#get_service_connections) | **GET** /service-connections | Get service connections\n*SystemApi* | [**info**](docs/SystemApi.md#info) | **GET** /info | Get system info\n*UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /users/{username} | Get user\n*UsersApi* | [**get_users**](docs/UsersApi.md#get_users) | **GET** /users | List users\n*UsersApi* | [**invite_user**](docs/UsersApi.md#invite_user) | **POST** /users | Invite user\n*UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PUT** /users/{username} | Update user\n\n\n## Documentation For Models\n\n - [AWSCredentials](docs/AWSCredentials.md)\n - [AccessType](docs/AccessType.md)\n - [AllowedDataType](docs/AllowedDataType.md)\n - [BillingAccount](docs/BillingAccount.md)\n - [BillingAccountRequest](docs/BillingAccountRequest.md)\n - [BillingMethod](docs/BillingMethod.md)\n - [BudgetPeriod](docs/BudgetPeriod.md)\n - [CloudAccount](docs/CloudAccount.md)\n - [Contact](docs/Contact.md)\n - [CreateNotebookInstanceRequest](docs/CreateNotebookInstanceRequest.md)\n - [CreateReferenceRequest](docs/CreateReferenceRequest.md)\n - [CreateResponse](docs/CreateResponse.md)\n - [CustomPipelineSettings](docs/CustomPipelineSettings.md)\n - [CustomerType](docs/CustomerType.md)\n - [Dashboard](docs/Dashboard.md)\n - [DashboardRequest](docs/DashboardRequest.md)\n - [Dataset](docs/Dataset.md)\n - [DatasetAssetsManifest](docs/DatasetAssetsManifest.md)\n - [DatasetDetail](docs/DatasetDetail.md)\n - [DatasetViz](docs/DatasetViz.md)\n - [ErrorMessage](docs/ErrorMessage.md)\n - [Executor](docs/Executor.md)\n - [FileAccessRequest](docs/FileAccessRequest.md)\n - [FileEntry](docs/FileEntry.md)\n - [FileNamePattern](docs/FileNamePattern.md)\n - [FileRequirements](docs/FileRequirements.md)\n - [FormSchema](docs/FormSchema.md)\n - [GenerateSftpCredentialsRequest](docs/GenerateSftpCredentialsRequest.md)\n - [GetExecutionLogsResponse](docs/GetExecutionLogsResponse.md)\n - [ImportDataRequest](docs/ImportDataRequest.md)\n - [InviteUserRequest](docs/InviteUserRequest.md)\n - [InviteUserResponse](docs/InviteUserResponse.md)\n - [LogEntry](docs/LogEntry.md)\n - [MetricRecord](docs/MetricRecord.md)\n - [NotebookInstance](docs/NotebookInstance.md)\n - [NotebookInstanceStatusResponse](docs/NotebookInstanceStatusResponse.md)\n - [OpenNotebookInstanceResponse](docs/OpenNotebookInstanceResponse.md)\n - [PaginatedResponseDatasetListDto](docs/PaginatedResponseDatasetListDto.md)\n - [PaginatedResponseSampleDto](docs/PaginatedResponseSampleDto.md)\n - [PipelineCode](docs/PipelineCode.md)\n - [PortalErrorResponse](docs/PortalErrorResponse.md)\n - [Process](docs/Process.md)\n - [ProcessDetail](docs/ProcessDetail.md)\n - [ProcessDetailAllOfPipelineCode](docs/ProcessDetailAllOfPipelineCode.md)\n - [Project](docs/Project.md)\n - [ProjectDetail](docs/ProjectDetail.md)\n - [ProjectMetrics](docs/ProjectMetrics.md)\n - [ProjectRequest](docs/ProjectRequest.md)\n - [ProjectRole](docs/ProjectRole.md)\n - [ProjectSettings](docs/ProjectSettings.md)\n - [ProjectUser](docs/ProjectUser.md)\n - [Reference](docs/Reference.md)\n - [ReferenceType](docs/ReferenceType.md)\n - [RepositoryType](docs/RepositoryType.md)\n - [ResourcesInfo](docs/ResourcesInfo.md)\n - [RunAnalysisRequest](docs/RunAnalysisRequest.md)\n - [Sample](docs/Sample.md)\n - [SampleRequest](docs/SampleRequest.md)\n - [ServiceConnection](docs/ServiceConnection.md)\n - [SetUserProjectRoleRequest](docs/SetUserProjectRoleRequest.md)\n - [SftpCredentials](docs/SftpCredentials.md)\n - [Status](docs/Status.md)\n - [StopExecutionResponse](docs/StopExecutionResponse.md)\n - [SyncStatus](docs/SyncStatus.md)\n - [SystemInfoResponse](docs/SystemInfoResponse.md)\n - [Tag](docs/Tag.md)\n - [Task](docs/Task.md)\n - [UpdateDatasetRequest](docs/UpdateDatasetRequest.md)\n - [UpdateUserRequest](docs/UpdateUserRequest.md)\n - [UploadDatasetCreateResponse](docs/UploadDatasetCreateResponse.md)\n - [UploadDatasetRequest](docs/UploadDatasetRequest.md)\n - [User](docs/User.md)\n - [ValidateFileRequirementsRequest](docs/ValidateFileRequirementsRequest.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=\"accessToken\"></a>\n### accessToken\n\n- **Type**: Bearer authentication (JWT)\n\n\n## Author\n\nsupport@cirro.bio\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Cirro Data",
"version": "0.0.1a0",
"project_urls": {
"Homepage": "https://github.com/CirroBio/Cirro-client-python",
"Repository": "https://github.com/CirroBio/Cirro-client-python"
},
"split_keywords": [
"openapi",
"openapi-generator",
"cirro data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "89caf39137bbeb36a911c10993c32d24fa44eabbb907d21a180b9f56d184e5d4",
"md5": "5c82cde9efcd0137e0474aa33fc06475",
"sha256": "28303d932a2d7ee65c4c72d22f9fc1c5ebfdc2ff0ac1883f1451ef59edafe086"
},
"downloads": -1,
"filename": "cirro_api_client-0.0.1a0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5c82cde9efcd0137e0474aa33fc06475",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 157639,
"upload_time": "2024-01-21T23:48:25",
"upload_time_iso_8601": "2024-01-21T23:48:25.946437Z",
"url": "https://files.pythonhosted.org/packages/89/ca/f39137bbeb36a911c10993c32d24fa44eabbb907d21a180b9f56d184e5d4/cirro_api_client-0.0.1a0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c71758361b0b875cc20d39ceae60ca12d3b0386694efeb37ef66dc93d8f62dab",
"md5": "97ecb1f20b10018bd6fc7da5c7d9de6d",
"sha256": "86b76cdb10492e76bab5e5cdbcd1e1b008b14b9dab0852cd4c648a128f20068c"
},
"downloads": -1,
"filename": "cirro_api_client-0.0.1a0.tar.gz",
"has_sig": false,
"md5_digest": "97ecb1f20b10018bd6fc7da5c7d9de6d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 59611,
"upload_time": "2024-01-21T23:48:28",
"upload_time_iso_8601": "2024-01-21T23:48:28.023201Z",
"url": "https://files.pythonhosted.org/packages/c7/17/58361b0b875cc20d39ceae60ca12d3b0386694efeb37ef66dc93d8f62dab/cirro_api_client-0.0.1a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-21 23:48:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CirroBio",
"github_project": "Cirro-client-python",
"github_not_found": true,
"lcname": "cirro-api-client"
}
JSON
