terra-scientific-pipelines-service-api-client 0.1.28__tar.gz

terra_scientific_pipelines_service_api_client-0.1.28/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.2
+Name: terra-scientific-pipelines-service-api-client
+Version: 0.1.28
+Summary: Terra Scientific Pipelines Service
+Home-page: 
+Author: OpenAPI Generator community
+Author-email: team@openapitools.org
+Keywords: OpenAPI,OpenAPI-Generator,Terra Scientific Pipelines Service
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=1.25.3
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: summary
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    

terra_scientific_pipelines_service_api_client-0.1.28/README.md

@@ -0,0 +1,169 @@
+# terra-scientific-pipelines-service-api-client
+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: 1.0.0
+- Package version: 0.1.28
+- Generator version: 7.9.0
+- 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 teaspoons_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 teaspoons_client
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import teaspoons_client
+from teaspoons_client.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 = teaspoons_client.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.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Configure Bearer authorization: bearerAuth
+configuration = teaspoons_client.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+
+# Enter a context with an instance of the API client
+with teaspoons_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = teaspoons_client.AdminApi(api_client)
+    pipeline_name = 'pipeline_name_example' # str | A string identifier to used to identify a pipeline in the service.
+    pipeline_version = 56 # int | The integer version of the pipeline.
+
+    try:
+        # Get description for a given pipeline.
+        api_response = api_instance.get_pipeline(pipeline_name, pipeline_version)
+        print("The response of AdminApi->get_pipeline:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling AdminApi->get_pipeline: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AdminApi* | [**get_pipeline**](docs/AdminApi.md#get_pipeline) | **GET** /api/admin/v1/pipelines/{pipelineName}/{pipelineVersion} | Get description for a given pipeline.
+*AdminApi* | [**get_quota_for_pipeline_and_user**](docs/AdminApi.md#get_quota_for_pipeline_and_user) | **GET** /api/admin/v1/quotas/{pipelineName}/{userId} | Get quota for a given pipeline and user.
+*AdminApi* | [**update_pipeline**](docs/AdminApi.md#update_pipeline) | **PATCH** /api/admin/v1/pipelines/{pipelineName}/{pipelineVersion} | Update attributes for a given pipeline.
+*AdminApi* | [**update_quota_limit_for_pipeline_and_user**](docs/AdminApi.md#update_quota_limit_for_pipeline_and_user) | **PATCH** /api/admin/v1/quotas/{pipelineName}/{userId} | Update quota limit for a given pipeline and user.
+*JobsApi* | [**get_all_jobs**](docs/JobsApi.md#get_all_jobs) | **GET** /api/job/v1/jobs | Return a list of all jobs the caller has access to
+*JobsApi* | [**get_job**](docs/JobsApi.md#get_job) | **GET** /api/job/v1/jobs/{jobId} | Retrieve a specified job
+*PipelineRunsApi* | [**get_all_pipeline_runs**](docs/PipelineRunsApi.md#get_all_pipeline_runs) | **GET** /api/pipelineruns/v1/pipelineruns | Return a paginated list of all pipeline runs the caller has access to
+*PipelineRunsApi* | [**get_pipeline_run_result**](docs/PipelineRunsApi.md#get_pipeline_run_result) | **GET** /api/pipelineruns/v1/result/{jobId} | Retrieve result for a specified pipeline run
+*PipelineRunsApi* | [**prepare_pipeline_run**](docs/PipelineRunsApi.md#prepare_pipeline_run) | **POST** /api/pipelineruns/v1/prepare | Prepare a new pipeline run
+*PipelineRunsApi* | [**start_pipeline_run**](docs/PipelineRunsApi.md#start_pipeline_run) | **POST** /api/pipelineruns/v1/start | Start a prepared pipeline run
+*PipelinesApi* | [**get_pipeline_details**](docs/PipelinesApi.md#get_pipeline_details) | **POST** /api/pipelines/v1/{pipelineName} | Return info about the specified pipeline
+*PipelinesApi* | [**get_pipelines**](docs/PipelinesApi.md#get_pipelines) | **GET** /api/pipelines/v1 | Return all available Pipelines
+*PublicApi* | [**get_status**](docs/PublicApi.md#get_status) | **GET** /status | Check status of the service.
+*PublicApi* | [**get_version**](docs/PublicApi.md#get_version) | **GET** /version | Get version info of the deployed service.
+*QuotasApi* | [**get_quota_for_pipeline**](docs/QuotasApi.md#get_quota_for_pipeline) | **GET** /api/quotas/v1/{pipelineName} | Return info about the user's quota usage for the specified pipeline
+
+
+## Documentation For Models
+
+ - [AdminPipeline](docs/AdminPipeline.md)
+ - [AdminQuota](docs/AdminQuota.md)
+ - [AsyncPipelineRunResponse](docs/AsyncPipelineRunResponse.md)
+ - [ErrorReport](docs/ErrorReport.md)
+ - [GetJobsResponse](docs/GetJobsResponse.md)
+ - [GetPipelineDetailsRequestBody](docs/GetPipelineDetailsRequestBody.md)
+ - [GetPipelineRunsResponse](docs/GetPipelineRunsResponse.md)
+ - [GetPipelinesResult](docs/GetPipelinesResult.md)
+ - [JobControl](docs/JobControl.md)
+ - [JobReport](docs/JobReport.md)
+ - [JobResult](docs/JobResult.md)
+ - [Pipeline](docs/Pipeline.md)
+ - [PipelineRun](docs/PipelineRun.md)
+ - [PipelineRunReport](docs/PipelineRunReport.md)
+ - [PipelineUserProvidedInputDefinition](docs/PipelineUserProvidedInputDefinition.md)
+ - [PipelineWithDetails](docs/PipelineWithDetails.md)
+ - [PreparePipelineRunRequestBody](docs/PreparePipelineRunRequestBody.md)
+ - [PreparePipelineRunResponse](docs/PreparePipelineRunResponse.md)
+ - [QuotaWithDetails](docs/QuotaWithDetails.md)
+ - [StartPipelineRunRequestBody](docs/StartPipelineRunRequestBody.md)
+ - [SystemStatus](docs/SystemStatus.md)
+ - [SystemStatusSystemsValue](docs/SystemStatusSystemsValue.md)
+ - [UpdatePipelineRequestBody](docs/UpdatePipelineRequestBody.md)
+ - [UpdateQuotaLimitRequestBody](docs/UpdateQuotaLimitRequestBody.md)
+ - [VersionProperties](docs/VersionProperties.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="oidc"></a>
+### oidc
+
+- **Type**: OAuth
+- **Flow**: accessCode
+- **Authorization URL**: [[${authorityEndpoint}]]
+- **Scopes**: N/A
+
+<a id="bearerAuth"></a>
+### bearerAuth
+
+- **Type**: Bearer authentication
+
+
+## Author
+
+
+
+

terra_scientific_pipelines_service_api_client-0.1.28/pyproject.toml

@@ -0,0 +1,72 @@
+[tool.poetry]
+name = "teaspoons_client"
+version = "0.1.28"
+description = "Terra Scientific Pipelines Service"
+authors = ["OpenAPI Generator Community <team@openapitools.org>"]
+license = "NoLicense"
+readme = "README.md"
+repository = "https://github.com/GIT_USER_ID/GIT_REPO_ID"
+keywords = ["OpenAPI", "OpenAPI-Generator", "Terra Scientific Pipelines Service"]
+include = ["teaspoons_client/py.typed"]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+
+urllib3 = ">= 1.25.3 < 3.0.0"
+python-dateutil = ">= 2.8.2"
+pydantic = ">= 2"
+typing-extensions = ">= 4.7.1"
+
+[tool.poetry.dev-dependencies]
+pytest = ">= 7.2.1"
+pytest-cov = ">= 2.8.1"
+tox = ">= 3.9.0"
+flake8 = ">= 4.0.0"
+types-python-dateutil = ">= 2.8.19.14"
+mypy = ">= 1.5"
+
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"
+
+[tool.mypy]
+files = [
+  "teaspoons_client",
+  #"test",  # auto-generated tests
+  "tests", # hand-written tests
+]
+# TODO: enable "strict" once all these individual checks are passing
+# strict = true
+
+# List from: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+## Getting these passing should be easy
+strict_equality = true
+strict_concatenate = true
+
+## Strongly recommend enabling this one as soon as you can
+check_untyped_defs = true
+
+## These shouldn't be too much additional work, but may be tricky to
+## get passing if you use a lot of untyped libraries
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+
+### These next few are various gradations of forcing use of type annotations
+#disallow_untyped_calls = true
+#disallow_incomplete_defs = true
+#disallow_untyped_defs = true
+#
+### This one isn't too hard to get passing, but return on investment is lower
+#no_implicit_reexport = true
+#
+### This one can be tricky to get passing if you use a lot of untyped libraries
+#warn_return_any = true

terra_scientific_pipelines_service_api_client-0.1.28/setup.cfg

@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 99
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

terra_scientific_pipelines_service_api_client-0.1.28/setup.py

@@ -0,0 +1,49 @@
+# coding: utf-8
+
+"""
+    Terra Scientific Pipelines Service
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from setuptools import setup, find_packages  # noqa: H301
+
+# To install the library, run the following
+#
+# python setup.py install
+#
+# prerequisite: setuptools
+# http://pypi.python.org/pypi/setuptools
+NAME = "terra-scientific-pipelines-service-api-client"
+VERSION = "0.1.28"
+PYTHON_REQUIRES = ">= 3.8"
+REQUIRES = [
+    "urllib3 >= 1.25.3, < 3.0.0",
+    "python-dateutil >= 2.8.2",
+    "pydantic >= 2",
+    "typing-extensions >= 4.7.1",
+]
+
+setup(
+    name=NAME,
+    version=VERSION,
+    description="Terra Scientific Pipelines Service",
+    author="OpenAPI Generator community",
+    author_email="team@openapitools.org",
+    url="",
+    keywords=["OpenAPI", "OpenAPI-Generator", "Terra Scientific Pipelines Service"],
+    install_requires=REQUIRES,
+    packages=find_packages(exclude=["test", "tests"]),
+    include_package_data=True,
+    long_description_content_type='text/markdown',
+    long_description="""\
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    """,  # noqa: E501
+    package_data={"teaspoons_client": ["py.typed"]},
+)

terra_scientific_pipelines_service_api_client-0.1.28/teaspoons_client/__init__.py

@@ -0,0 +1,63 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Terra Scientific Pipelines Service
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "0.1.28"
+
+# import apis into sdk package
+from teaspoons_client.api.admin_api import AdminApi
+from teaspoons_client.api.jobs_api import JobsApi
+from teaspoons_client.api.pipeline_runs_api import PipelineRunsApi
+from teaspoons_client.api.pipelines_api import PipelinesApi
+from teaspoons_client.api.public_api import PublicApi
+from teaspoons_client.api.quotas_api import QuotasApi
+
+# import ApiClient
+from teaspoons_client.api_response import ApiResponse
+from teaspoons_client.api_client import ApiClient
+from teaspoons_client.configuration import Configuration
+from teaspoons_client.exceptions import OpenApiException
+from teaspoons_client.exceptions import ApiTypeError
+from teaspoons_client.exceptions import ApiValueError
+from teaspoons_client.exceptions import ApiKeyError
+from teaspoons_client.exceptions import ApiAttributeError
+from teaspoons_client.exceptions import ApiException
+
+# import models into sdk package
+from teaspoons_client.models.admin_pipeline import AdminPipeline
+from teaspoons_client.models.admin_quota import AdminQuota
+from teaspoons_client.models.async_pipeline_run_response import AsyncPipelineRunResponse
+from teaspoons_client.models.error_report import ErrorReport
+from teaspoons_client.models.get_jobs_response import GetJobsResponse
+from teaspoons_client.models.get_pipeline_details_request_body import GetPipelineDetailsRequestBody
+from teaspoons_client.models.get_pipeline_runs_response import GetPipelineRunsResponse
+from teaspoons_client.models.get_pipelines_result import GetPipelinesResult
+from teaspoons_client.models.job_control import JobControl
+from teaspoons_client.models.job_report import JobReport
+from teaspoons_client.models.job_result import JobResult
+from teaspoons_client.models.pipeline import Pipeline
+from teaspoons_client.models.pipeline_run import PipelineRun
+from teaspoons_client.models.pipeline_run_report import PipelineRunReport
+from teaspoons_client.models.pipeline_user_provided_input_definition import PipelineUserProvidedInputDefinition
+from teaspoons_client.models.pipeline_with_details import PipelineWithDetails
+from teaspoons_client.models.prepare_pipeline_run_request_body import PreparePipelineRunRequestBody
+from teaspoons_client.models.prepare_pipeline_run_response import PreparePipelineRunResponse
+from teaspoons_client.models.quota_with_details import QuotaWithDetails
+from teaspoons_client.models.start_pipeline_run_request_body import StartPipelineRunRequestBody
+from teaspoons_client.models.system_status import SystemStatus
+from teaspoons_client.models.system_status_systems_value import SystemStatusSystemsValue
+from teaspoons_client.models.update_pipeline_request_body import UpdatePipelineRequestBody
+from teaspoons_client.models.update_quota_limit_request_body import UpdateQuotaLimitRequestBody
+from teaspoons_client.models.version_properties import VersionProperties

terra_scientific_pipelines_service_api_client-0.1.28/teaspoons_client/api/__init__.py

@@ -0,0 +1,10 @@
+# flake8: noqa
+
+# import apis into api package
+from teaspoons_client.api.admin_api import AdminApi
+from teaspoons_client.api.jobs_api import JobsApi
+from teaspoons_client.api.pipeline_runs_api import PipelineRunsApi
+from teaspoons_client.api.pipelines_api import PipelinesApi
+from teaspoons_client.api.public_api import PublicApi
+from teaspoons_client.api.quotas_api import QuotasApi
+