# preemo-python-sdk
Model API
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 1.0.0-dev.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 preemo
```
### 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 preemo
```
### 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 preemo
from preemo.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://preemo.io/api
# See configuration.py for a list of all supported configuration parameters.
configuration = preemo.Configuration(
host = "https://preemo.io/api"
)
# 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 API key authorization: x-preemo-browser-client
configuration.api_key['x-preemo-browser-client'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-preemo-browser-client'] = 'Bearer'
# Configure Bearer authorization (JWT): bearerAuth
configuration = preemo.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with preemo.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = preemo.DefaultApi(api_client)
id = None # object |
x_preemo_workspace_id = None # object |
try:
# Agree to the license
api_response = api_instance.create_license(id, x_preemo_workspace_id)
print("The response of DefaultApi->create_license:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->create_license: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://preemo.io/api*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**create_license**](docs/DefaultApi.md#create_license) | **POST** /licenses/{id} | Agree to the license
*DefaultApi* | [**create_model**](docs/DefaultApi.md#create_model) | **POST** /models | Create model
*DefaultApi* | [**delete_model**](docs/DefaultApi.md#delete_model) | **DELETE** /models/{id} | Delete model.
*DefaultApi* | [**get_license**](docs/DefaultApi.md#get_license) | **GET** /licenses/{id} | Describe license
*DefaultApi* | [**get_model**](docs/DefaultApi.md#get_model) | **GET** /models/{id} | Describe model
*DefaultApi* | [**get_model_licenses**](docs/DefaultApi.md#get_model_licenses) | **GET** /models/{id}/licenses | License info for model
*DefaultApi* | [**list_models**](docs/DefaultApi.md#list_models) | **GET** /models | List available models
*DefaultApi* | [**query_model**](docs/DefaultApi.md#query_model) | **GET** /models/{id}/queries | Query model
*DefaultApi* | [**train_model**](docs/DefaultApi.md#train_model) | **POST** /models/{id}/instructions | Train model
## Documentation For Models
- [CreateLicenseError](docs/CreateLicenseError.md)
- [CreateModelError](docs/CreateModelError.md)
- [CreateModelRequestBody](docs/CreateModelRequestBody.md)
- [CreateModelRequestBodyModel](docs/CreateModelRequestBodyModel.md)
- [DeleteModelError](docs/DeleteModelError.md)
- [GetLicenseError](docs/GetLicenseError.md)
- [GetLicenseSuccess](docs/GetLicenseSuccess.md)
- [GetModelError](docs/GetModelError.md)
- [GetModelLicensesError](docs/GetModelLicensesError.md)
- [GetModelLicensesSuccess](docs/GetModelLicensesSuccess.md)
- [GetModelSuccess](docs/GetModelSuccess.md)
- [ListModelsError](docs/ListModelsError.md)
- [ListModelsSuccess](docs/ListModelsSuccess.md)
- [QueryModelError](docs/QueryModelError.md)
- [QueryModelSuccess](docs/QueryModelSuccess.md)
- [TrainModelError](docs/TrainModelError.md)
- [TrainModelRequestBody](docs/TrainModelRequestBody.md)
- [TrainModelRequestBodyTrainingArguments](docs/TrainModelRequestBodyTrainingArguments.md)
- [TrainModelSuccess](docs/TrainModelSuccess.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="x-preemo-browser-client"></a>
### x-preemo-browser-client
- **Type**: API key
- **API key parameter name**: x-preemo-browser-client
- **Location**: HTTP header
<a id="bearerAuth"></a>
### bearerAuth
- **Type**: Bearer authentication (JWT)
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "preemo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,Model API",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/7f/81/09ed3e27b85f48fe61248a2c27f45e387bba3c6e9ce7ad2a873853ec8508/preemo-1.0.0.dev0.tar.gz",
"platform": null,
"description": "# preemo-python-sdk\nModel API\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0-dev.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\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/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport preemo\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 preemo\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 preemo\nfrom preemo.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://preemo.io/api\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = preemo.Configuration(\n host = \"https://preemo.io/api\"\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 API key authorization: x-preemo-browser-client\nconfiguration.api_key['x-preemo-browser-client'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['x-preemo-browser-client'] = 'Bearer'\n\n# Configure Bearer authorization (JWT): bearerAuth\nconfiguration = preemo.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith preemo.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = preemo.DefaultApi(api_client)\n id = None # object | \n x_preemo_workspace_id = None # object | \n\n try:\n # Agree to the license\n api_response = api_instance.create_license(id, x_preemo_workspace_id)\n print(\"The response of DefaultApi->create_license:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->create_license: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://preemo.io/api*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**create_license**](docs/DefaultApi.md#create_license) | **POST** /licenses/{id} | Agree to the license\n*DefaultApi* | [**create_model**](docs/DefaultApi.md#create_model) | **POST** /models | Create model\n*DefaultApi* | [**delete_model**](docs/DefaultApi.md#delete_model) | **DELETE** /models/{id} | Delete model.\n*DefaultApi* | [**get_license**](docs/DefaultApi.md#get_license) | **GET** /licenses/{id} | Describe license\n*DefaultApi* | [**get_model**](docs/DefaultApi.md#get_model) | **GET** /models/{id} | Describe model\n*DefaultApi* | [**get_model_licenses**](docs/DefaultApi.md#get_model_licenses) | **GET** /models/{id}/licenses | License info for model\n*DefaultApi* | [**list_models**](docs/DefaultApi.md#list_models) | **GET** /models | List available models\n*DefaultApi* | [**query_model**](docs/DefaultApi.md#query_model) | **GET** /models/{id}/queries | Query model\n*DefaultApi* | [**train_model**](docs/DefaultApi.md#train_model) | **POST** /models/{id}/instructions | Train model\n\n\n## Documentation For Models\n\n - [CreateLicenseError](docs/CreateLicenseError.md)\n - [CreateModelError](docs/CreateModelError.md)\n - [CreateModelRequestBody](docs/CreateModelRequestBody.md)\n - [CreateModelRequestBodyModel](docs/CreateModelRequestBodyModel.md)\n - [DeleteModelError](docs/DeleteModelError.md)\n - [GetLicenseError](docs/GetLicenseError.md)\n - [GetLicenseSuccess](docs/GetLicenseSuccess.md)\n - [GetModelError](docs/GetModelError.md)\n - [GetModelLicensesError](docs/GetModelLicensesError.md)\n - [GetModelLicensesSuccess](docs/GetModelLicensesSuccess.md)\n - [GetModelSuccess](docs/GetModelSuccess.md)\n - [ListModelsError](docs/ListModelsError.md)\n - [ListModelsSuccess](docs/ListModelsSuccess.md)\n - [QueryModelError](docs/QueryModelError.md)\n - [QueryModelSuccess](docs/QueryModelSuccess.md)\n - [TrainModelError](docs/TrainModelError.md)\n - [TrainModelRequestBody](docs/TrainModelRequestBody.md)\n - [TrainModelRequestBodyTrainingArguments](docs/TrainModelRequestBodyTrainingArguments.md)\n - [TrainModelSuccess](docs/TrainModelSuccess.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=\"x-preemo-browser-client\"></a>\n### x-preemo-browser-client\n\n- **Type**: API key\n- **API key parameter name**: x-preemo-browser-client\n- **Location**: HTTP header\n\n<a id=\"bearerAuth\"></a>\n### bearerAuth\n\n- **Type**: Bearer authentication (JWT)\n\n\n## Author\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "Model API",
"version": "1.0.0.dev0",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
"openapi-generator",
"model api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1d03d7dacb18e01e6b04cb1886a952eca55458758c3ba87eadeab0d478641381",
"md5": "f907f05dd633423c9fb7f50e71bdccfd",
"sha256": "75da1a2e3209e042e5287041237727ea841bd0757c058e3834e450f2b020accb"
},
"downloads": -1,
"filename": "preemo-1.0.0.dev0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f907f05dd633423c9fb7f50e71bdccfd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 56525,
"upload_time": "2023-08-12T01:01:16",
"upload_time_iso_8601": "2023-08-12T01:01:16.115582Z",
"url": "https://files.pythonhosted.org/packages/1d/03/d7dacb18e01e6b04cb1886a952eca55458758c3ba87eadeab0d478641381/preemo-1.0.0.dev0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7f8109ed3e27b85f48fe61248a2c27f45e387bba3c6e9ce7ad2a873853ec8508",
"md5": "136420bb6e6218dd0f0e47304e0d3d67",
"sha256": "b04d9dbb4c1c81496301e1d510ac79b731f516a46ce02dd332407dff7b5476fa"
},
"downloads": -1,
"filename": "preemo-1.0.0.dev0.tar.gz",
"has_sig": false,
"md5_digest": "136420bb6e6218dd0f0e47304e0d3d67",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 26817,
"upload_time": "2023-08-12T01:01:18",
"upload_time_iso_8601": "2023-08-12T01:01:18.001515Z",
"url": "https://files.pythonhosted.org/packages/7f/81/09ed3e27b85f48fe61248a2c27f45e387bba3c6e9ce7ad2a873853ec8508/preemo-1.0.0.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-12 01:01:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "preemo"
}
JSON
