cosmotech-modeling-api

Cosmo Tech Modeling API (12.3.0-40541.660fc30e)

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

• API version: 12.3.0
• Package version: 12.3.0
• Generator version: 7.25.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

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-modeling-api-python-client.git

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

Then import the package:

import cosmotech_modeling_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_modeling_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import cosmotech_modeling_api
from cosmotech_modeling_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 = cosmotech_modeling_api.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with cosmotech_modeling_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_modeling_api.ConceptualModelApi(api_client)
    project_id = 'project_id_example' # str | The project identifier
    body = None # object | Conceptual model content

    try:
        # Check the semantic of a submitted conceptual model
        api_response = api_instance.check_conceptual_model_semantic_errors(project_id, body)
        print("The response of ConceptualModelApi->check_conceptual_model_semantic_errors:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ConceptualModelApi->check_conceptual_model_semantic_errors: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• AboutInfo
• AboutInfoVersion
• ProblemDetails
• ProblemDetailsSemanticErrors
• Project
• ProjectBuild
• ProjectBuildRequest
• ProjectBuildRequestBuildConfig
• ProjectBuildRequestDockerSimulatorImage
• ProjectBuildStatus
• ProjectRequest
• SemanticError
• SemanticErrorNodes

Documentation For Authorization

Endpoints do not require authorization.

Author

platform@cosmotech.com