cosmotech-api

Cosmo Tech Platform API

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

• API version: 5.3.0
• Package version: 1.0.0
• Generator version: 7.25.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://github.com/Cosmo-Tech/cosmotech-api

Requirements.

Python 3.10+

Installation & Usage

pip install

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

pip install git+https://github.com/Cosmo-Tech/cosmotech-api-python-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/Cosmo-Tech/cosmotech-api-python-client.git)

Then import the package:

import cosmotech_api

Setuptools

Install via Setuptools.

python setup.py install --user

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

Then import the package:

import cosmotech_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import cosmotech_api
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# 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_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.IAMInfoApi(api_client)

    try:
        # Get the list of all groups
        api_response = api_instance.list_iam_groups()
        print("The response of IAMInfoApi->list_iam_groups:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling IAMInfoApi->list_iam_groups: %s\n" % e)

Documentation for API Endpoints

Documentation For Models

• AboutInfo
• AboutInfoVersion
• ComponentRolePermissions
• ContainerResourceSizeInfo
• ContainerResourceSizing
• CreatedRun
• Dataset
• DatasetAccessControl
• DatasetCreateRequest
• DatasetEditInfo
• DatasetMemberGroup
• DatasetMemberUser
• DatasetMembers
• DatasetPart
• DatasetPartCreateRequest
• DatasetPartTypeEnum
• DatasetPartUpdateRequest
• DatasetRole
• DatasetSecurity
• DatasetUpdateRequest
• LastRunInfo
• MemberGroup
• MemberUser
• Members
• Organization
• OrganizationAccessControl
• OrganizationCreateRequest
• OrganizationEditInfo
• OrganizationMemberGroup
• OrganizationMemberUser
• OrganizationMembers
• OrganizationRole
• OrganizationSecurity
• OrganizationUpdateRequest
• ResourceSizeInfo
• Run
• RunContainer
• RunEditInfo
• RunResourceRequested
• RunState
• RunStatus
• RunStatusNode
• RunTemplate
• RunTemplateCreateRequest
• RunTemplateParameter
• RunTemplateParameterCreateRequest
• RunTemplateParameterGroup
• RunTemplateParameterGroupCreateRequest
• RunTemplateParameterGroupUpdateRequest
• RunTemplateParameterUpdateRequest
• RunTemplateParameterValue
• RunTemplateResourceSizing
• RunTemplateUpdateRequest
• Runner
• RunnerAccessControl
• RunnerCreateRequest
• RunnerDatasets
• RunnerEditInfo
• RunnerMemberGroup
• RunnerMemberUser
• RunnerMembers
• RunnerResourceSizing
• RunnerRole
• RunnerRunTemplateParameterValue
• RunnerSecurity
• RunnerStatus
• RunnerUpdateRequest
• RunnerValidationStatus
• Solution
• SolutionAccessControl
• SolutionCreateRequest
• SolutionEditInfo
• SolutionMemberGroup
• SolutionMemberUser
• SolutionMembers
• SolutionRole
• SolutionSecurity
• SolutionUpdateRequest
• Workspace
• WorkspaceAccessControl
• WorkspaceCreateRequest
• WorkspaceEditInfo
• WorkspaceFile
• WorkspaceMemberGroup
• WorkspaceMemberUser
• WorkspaceMembers
• WorkspaceRole
• WorkspaceSecurity
• WorkspaceSolution
• WorkspaceUpdateRequest

Documentation For Authorization

Authentication schemes defined for the API:

oAuth2AuthCode

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://example.com/authorize
• Scopes: N/A

Author

platform@cosmotech.com