> **_NOTE:_**
> Some links in this generated README.md are broken as they are relative path. To use the README.md with working links, download the [Source Distribution](https://pypi.org/project/text2motion-client-api/#files) under Download files and open README.md in a Markdown previewer.
# text2motion-client-api
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: 0.1.10
- Package version: 0.1.3
- 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 text2motion_client_api
```
### 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 text2motion_client_api
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import text2motion_client_api
from text2motion_client_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.text2motion.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = text2motion_client_api.Configuration(
host = "https://api.text2motion.ai"
)
# 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: APIKeyHeader
configuration.api_key['APIKeyHeader'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKeyHeader'] = 'Bearer'
# Enter a context with an instance of the API client
with text2motion_client_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = text2motion_client_api.FeedbackApi(api_client)
feedback_request_body = text2motion_client_api.FeedbackRequestBody() # FeedbackRequestBody |
try:
# Feedback
api_response = api_instance.feedback_api_feedback_post(feedback_request_body)
print("The response of FeedbackApi->feedback_api_feedback_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling FeedbackApi->feedback_api_feedback_post: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.text2motion.ai*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*FeedbackApi* | [**feedback_api_feedback_post**](docs/FeedbackApi.md#feedback_api_feedback_post) | **POST** /api/feedback | Feedback
*FeedbackApi* | [**feedback_api_labs010_feedback_post**](docs/FeedbackApi.md#feedback_api_labs010_feedback_post) | **POST** /api/labs/0.1.0/feedback | Feedback
*GenerateApi* | [**generate_api_generate_post**](docs/GenerateApi.md#generate_api_generate_post) | **POST** /api/generate | Generate
*GenerateApi* | [**generate_api_labs010_generate_post**](docs/GenerateApi.md#generate_api_labs010_generate_post) | **POST** /api/labs/0.1.0/generate | Generate
## Documentation For Models
- [Bone](docs/Bone.md)
- [FeedbackRequestBody](docs/FeedbackRequestBody.md)
- [GenerateRequestBody](docs/GenerateRequestBody.md)
- [GenerateResponseBody](docs/GenerateResponseBody.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [LocationInner](docs/LocationInner.md)
- [Skeleton](docs/Skeleton.md)
- [ValidationError](docs/ValidationError.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="APIKeyHeader"></a>
### APIKeyHeader
- **Type**: API key
- **API key parameter name**: x-apikey
- **Location**: HTTP header
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/text2motion/python-client",
"name": "text2motion-client-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Text2Motion API",
"author": "Text2Motion",
"author_email": "support@text2motion.ai",
"download_url": "https://files.pythonhosted.org/packages/ba/bb/5dc86960d924b64f4a7173107ef7123c5ec80f7b434c28c11c469a7139e3/text2motion_client_api-0.1.3.tar.gz",
"platform": null,
"description": "> **_NOTE:_** \n> Some links in this generated README.md are broken as they are relative path. To use the README.md with working links, download the [Source Distribution](https://pypi.org/project/text2motion-client-api/#files) under Download files and open README.md in a Markdown previewer.\n\n# text2motion-client-api\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.1.10\n- Package version: 0.1.3\n- Generator version: 7.9.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 text2motion_client_api\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 text2motion_client_api\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 text2motion_client_api\nfrom text2motion_client_api.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://api.text2motion.ai\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = text2motion_client_api.Configuration(\n host = \"https://api.text2motion.ai\"\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: APIKeyHeader\nconfiguration.api_key['APIKeyHeader'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['APIKeyHeader'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith text2motion_client_api.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = text2motion_client_api.FeedbackApi(api_client)\n feedback_request_body = text2motion_client_api.FeedbackRequestBody() # FeedbackRequestBody | \n\n try:\n # Feedback\n api_response = api_instance.feedback_api_feedback_post(feedback_request_body)\n print(\"The response of FeedbackApi->feedback_api_feedback_post:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling FeedbackApi->feedback_api_feedback_post: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.text2motion.ai*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*FeedbackApi* | [**feedback_api_feedback_post**](docs/FeedbackApi.md#feedback_api_feedback_post) | **POST** /api/feedback | Feedback\n*FeedbackApi* | [**feedback_api_labs010_feedback_post**](docs/FeedbackApi.md#feedback_api_labs010_feedback_post) | **POST** /api/labs/0.1.0/feedback | Feedback\n*GenerateApi* | [**generate_api_generate_post**](docs/GenerateApi.md#generate_api_generate_post) | **POST** /api/generate | Generate\n*GenerateApi* | [**generate_api_labs010_generate_post**](docs/GenerateApi.md#generate_api_labs010_generate_post) | **POST** /api/labs/0.1.0/generate | Generate\n\n\n## Documentation For Models\n\n - [Bone](docs/Bone.md)\n - [FeedbackRequestBody](docs/FeedbackRequestBody.md)\n - [GenerateRequestBody](docs/GenerateRequestBody.md)\n - [GenerateResponseBody](docs/GenerateResponseBody.md)\n - [HTTPValidationError](docs/HTTPValidationError.md)\n - [LocationInner](docs/LocationInner.md)\n - [Skeleton](docs/Skeleton.md)\n - [ValidationError](docs/ValidationError.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=\"APIKeyHeader\"></a>\n### APIKeyHeader\n\n- **Type**: API key\n- **API key parameter name**: x-apikey\n- **Location**: HTTP header\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "OpenAPI generated Python client for Text2Motion API",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/text2motion/python-client"
},
"split_keywords": [
"openapi",
" openapi-generator",
" text2motion api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "563b8fa8a2f25d6517df4a0107cebb5a57f3cd29ac5bb83964bd3bf47d8522a8",
"md5": "0cc289c9717e0525afa28913169f2e6e",
"sha256": "2855b00b042861ddca75b24b89595cc361c7746508fda28e78ea857c2117a04a"
},
"downloads": -1,
"filename": "text2motion_client_api-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0cc289c9717e0525afa28913169f2e6e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 36929,
"upload_time": "2024-12-16T23:02:49",
"upload_time_iso_8601": "2024-12-16T23:02:49.253015Z",
"url": "https://files.pythonhosted.org/packages/56/3b/8fa8a2f25d6517df4a0107cebb5a57f3cd29ac5bb83964bd3bf47d8522a8/text2motion_client_api-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "babb5dc86960d924b64f4a7173107ef7123c5ec80f7b434c28c11c469a7139e3",
"md5": "70d50a076e9b16d562b01eab072f23f4",
"sha256": "52fd725ec4029c5cc8547e9441e142a14300dd090af28075794170c67972fe1b"
},
"downloads": -1,
"filename": "text2motion_client_api-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "70d50a076e9b16d562b01eab072f23f4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34342,
"upload_time": "2024-12-16T23:02:50",
"upload_time_iso_8601": "2024-12-16T23:02:50.610545Z",
"url": "https://files.pythonhosted.org/packages/ba/bb/5dc86960d924b64f4a7173107ef7123c5ec80f7b434c28c11c469a7139e3/text2motion_client_api-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 23:02:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "text2motion",
"github_project": "python-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "setuptools",
"specs": [
[
">=",
"38.6.0"
]
]
},
{
"name": "wheel",
"specs": [
[
">=",
"0.31.0"
]
]
},
{
"name": "twine",
"specs": [
[
">=",
"1.11.0"
]
]
},
{
"name": "build",
"specs": []
}
],
"lcname": "text2motion-client-api"
}
JSON
