cirro_api_client 0.0.3

Cirro Data

Cirro API Client

Cirro Data Platform service API

This Python package is automatically generated by the OpenAPI Generator project:

Requirements.

Python 3.7+

Installation & Usage

pip install

Via PyPI:

pip install cirro-api-client

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

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)

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import os
from cirro_api_client import Configuration, CirroApiClient
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.
# The access_token param can be either a string, or a function that returns a string.
configuration = Configuration(
    host = "https://api.cirro.bio",
    access_token = os.environ["BEARER_TOKEN"]
)

# Create instance of the API client
api_client = CirroApiClient(configuration)

try:
    # Get list of projects
    projects = api_client.projects.get_projects()
    print("The response of Projects->get_projects:\n")
    pprint(projects)
except ApiException as e:
    print("Exception when calling Projects->get_projects: %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	POST /billing	Create billing account
BillingApi	delete_billing_account	DELETE /billing/{billingAccountId}	Delete billing account
BillingApi	generate_billing_report	GET /billing-report	Generate billing report
BillingApi	get_billing_accounts	GET /billing	List billing accounts
BillingApi	update_billing_account	PUT /billing/{billingAccountId}	Update billing account
DashboardsApi	create_dashboard	POST /projects/{projectId}/dashboards	Create dashboard
DashboardsApi	delete_dashboard	DELETE /projects/{projectId}/dashboards/{dashboardId}	Delete dashboard
DashboardsApi	get_dashboard	GET /projects/{projectId}/dashboards/{dashboardId}	Get dashboard
DashboardsApi	get_dashboards	GET /projects/{projectId}/dashboards	List dashboards
DashboardsApi	update_dashboard	PUT /projects/{projectId}/dashboards/{dashboardId}	Update dashboard
DatasetsApi	delete_dataset	DELETE /projects/{projectId}/datasets/{datasetId}	Delete a dataset
DatasetsApi	get_dataset	GET /projects/{projectId}/datasets/{datasetId}	Get dataset
DatasetsApi	get_dataset_manifest	GET /projects/{projectId}/datasets/{datasetId}/files	Get dataset manifest
DatasetsApi	get_datasets	GET /projects/{projectId}/datasets	List datasets
DatasetsApi	import_public_dataset	POST /projects/{projectId}/datasets/import	Import public dataset
DatasetsApi	ingest_samples	PUT /projects/{projectId}/datasets/{datasetId}/ingest-samples	Rerun sample ingest
DatasetsApi	regenerate_manifest	PUT /projects/{projectId}/datasets/{datasetId}/regenerate-manifest	Regenerate dataset manifest
DatasetsApi	rerun_transform	PUT /projects/{projectId}/datasets/{datasetId}/rerun-transform	Rerun data transforms
DatasetsApi	update_dataset	PUT /projects/{projectId}/datasets/{datasetId}	Update dataset
DatasetsApi	upload_dataset	POST /projects/{projectId}/datasets/upload	Upload private dataset
ExecutionApi	get_execution_logs	GET /projects/{projectId}/execution/{datasetId}/logs	Get execution logs
ExecutionApi	get_project_summary	GET /projects/{projectId}/execution	Get execution summary
ExecutionApi	get_task_logs	GET /projects/{projectId}/execution/{datasetId}/tasks/{taskId}/logs	Get task logs
ExecutionApi	get_tasks_for_execution	GET /projects/{projectId}/execution/{datasetId}/tasks	Get execution tasks
ExecutionApi	run_analysis	POST /projects/{projectId}/execution	Run analysis
ExecutionApi	stop_analysis	PUT /projects/{projectId}/execution/{datasetId}/stop	Stop execution
FileApi	generate_project_file_access_token	POST /projects/{projectId}/s3-token	Create project file access token
FileApi	generate_project_sftp_token	POST /projects/{projectId}/sftp-token	Create project SFTP Token
MetadataApi	get_project_samples	GET /projects/{projectId}/samples	Get project samples
MetadataApi	get_project_schema	GET /projects/{projectId}/schema	Get project metadata schema
MetadataApi	update_project_schema	PUT /projects/{projectId}/schema	Update project metadata schema
MetadataApi	update_sample	PUT /projects/{projectId}/samples/{sampleId}	Update sample
MetricsApi	get_all_metrics	GET /metrics	Get all project metrics
MetricsApi	get_project_metrics	GET /projects/{projectId}/metrics	Get project metrics
NotebooksApi	create_notebook_instance	POST /projects/{projectId}/notebook-instances	Create notebook instance
NotebooksApi	delete_notebook_instance	DELETE /projects/{projectId}/notebook-instances/{notebookInstanceId}	Delete notebook instance
NotebooksApi	generate_notebook_instance_url	GET /projects/{projectId}/notebook-instances/{notebookInstanceId}:generate-url	Generate notebook instance URL
NotebooksApi	get_notebook_instance_status	GET /projects/{projectId}/notebook-instances/{notebookInstanceId}:status	Get notebook instance status
NotebooksApi	get_notebook_instances	GET /projects/{projectId}/notebook-instances	Get notebook instances
NotebooksApi	stop_notebook_instance	POST /projects/{projectId}/notebook-instances/{notebookInstanceId}:stop	Stop notebook instance
ProcessesApi	archive_custom_process	DELETE /processes/{processId}	Archive custom process
ProcessesApi	create_custom_process	POST /processes	Create custom process
ProcessesApi	get_process	GET /processes/{processId}	Get process
ProcessesApi	get_process_parameters	GET /processes/{processId}/parameters	Get process parameters
ProcessesApi	get_processes	GET /processes	List processes
ProcessesApi	sync_custom_process	PUT /processes/{processId}:sync	Sync custom process
ProcessesApi	update_custom_process	PUT /processes/{processId}	Update custom process
ProcessesApi	validate_file_requirements	POST /processes/{processId}/validate-files	Validate file requirements
ProjectsApi	create_project	POST /projects	Create project
ProjectsApi	get_project	GET /projects/{projectId}	Get project
ProjectsApi	get_project_users	GET /projects/{projectId}/permissions	Get project permissions
ProjectsApi	get_projects	GET /projects	Get projects
ProjectsApi	redeploy_project	PUT /projects/{projectId}:re-deploy	Redeploy project
ProjectsApi	set_user_project_role	PUT /projects/{projectId}/permissions	Set role
ProjectsApi	update_project	PUT /projects/{projectId}	Update project
ProjectsApi	update_project_tags	PUT /projects/{projectId}:tags	Set project tags
ReferencesApi	create_project_reference	POST /projects/{projectId}/references	Create project reference
ReferencesApi	delete_project_reference	DELETE /projects/{projectId}/references	Delete project reference
ReferencesApi	get_reference_types	GET /reference-types	Get reference types
ReferencesApi	get_references	GET /references	Get global references
ReferencesApi	get_references_for_project	GET /projects/{projectId}/references	Get project references
ReferencesApi	refresh_project_references	PUT /projects/{projectId}/references	Refresh project references
SystemApi	get_service_connections	GET /service-connections	Get service connections
SystemApi	info	GET /info	Get system info
UsersApi	get_user	GET /users/{username}	Get user
UsersApi	get_users	GET /users	List users
UsersApi	invite_user	POST /users	Invite user
UsersApi	update_user	PUT /users/{username}	Update user

Documentation For Models

• AWSCredentials
• AccessType
• AllowedDataType
• BillingAccount
• BillingAccountRequest
• BillingMethod
• BudgetPeriod
• CloudAccount
• Contact
• CreateNotebookInstanceRequest
• CreateReferenceRequest
• CreateResponse
• CustomPipelineSettings
• CustomerType
• Dashboard
• DashboardRequest
• Dataset
• DatasetAssetsManifest
• DatasetDetail
• DatasetViz
• ErrorMessage
• Executor
• FileAccessRequest
• FileEntry
• FileNamePattern
• FileRequirements
• FormSchema
• GenerateSftpCredentialsRequest
• GetExecutionLogsResponse
• ImportDataRequest
• InviteUserRequest
• InviteUserResponse
• LogEntry
• MetricRecord
• NotebookInstance
• NotebookInstanceStatusResponse
• OpenNotebookInstanceResponse
• PaginatedResponseDatasetListDto
• PaginatedResponseSampleDto
• PipelineCode
• PortalErrorResponse
• Process
• ProcessDetail
• ProcessDetailAllOfPipelineCode
• Project
• ProjectDetail
• ProjectMetrics
• ProjectRequest
• ProjectRole
• ProjectSettings
• ProjectUser
• Reference
• ReferenceType
• RepositoryType
• ResourcesInfo
• RunAnalysisRequest
• Sample
• SampleRequest
• ServiceConnection
• SetUserProjectRoleRequest
• SftpCredentials
• Status
• StopExecutionResponse
• SyncStatus
• SystemInfoResponse
• Tag
• Task
• UpdateDatasetRequest
• UpdateUserRequest
• UploadDatasetCreateResponse
• UploadDatasetRequest
• User
• ValidateFileRequirementsRequest

Documentation For Authorization

Authentication schemes defined for the API:

accessToken

• Type: Bearer authentication (JWT)

Author

[e-mail]