# Python client generator for OpenAPI schema
## Requirements
Python 3.7+
Docker engine. [Documentation](https://docs.docker.com/engine/install/)
## Usage
To generate the client, execute the following command
```bash
python ./generator/generate.py <a path or URL to a .yaml file>
```
Examples:
```bash
python ./generator/generate.py -h
python ./generator/generate.py https://<domain>/openapi.json
python ./generator/generate.py https://<domain>/openapi.json --asyncio
python ./generator/generate.py /<path>/openapi.yaml
python ./generator/generate.py /<path>/openapi.yaml --asyncio
```
# openapi-client
This is a OpenAPI schema of the template-python app
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.1.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
1. If you don't have `Poetry` installed run:
```bash
pip install poetry
```
2. Install dependencies:
```bash
poetry config virtualenvs.in-project true
poetry install --no-root
```
3. Running tests:
```bash
poetry run pytest
```
4. Building package:
```bash
poetry build
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import openapi_client
from openapi_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 = openapi_client.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = openapi_client.DefaultApi(api_client)
try:
# Example endpoint
api_response = api_instance.example_get()
print("The response of DefaultApi->example_get:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->example_get: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**example_get**](docs/DefaultApi.md#example_get) | **GET** / | Example endpoint
*ItemsApi* | [**items_create**](docs/ItemsApi.md#items_create) | **POST** /item/ | Create an item
*ItemsApi* | [**items_delete_item**](docs/ItemsApi.md#items_delete_item) | **DELETE** /item/{id}/ | Delete an item
*ItemsApi* | [**items_read_all**](docs/ItemsApi.md#items_read_all) | **GET** /item/ | Read all items
*ItemsApi* | [**items_read_item**](docs/ItemsApi.md#items_read_item) | **GET** /item/{id}/ | Read an item
*ItemsApi* | [**items_update_item**](docs/ItemsApi.md#items_update_item) | **PUT** /item/{id}/ | Update an item
## Documentation For Models
- [ExampleResponse](docs/ExampleResponse.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [Item](docs/Item.md)
- [ValidationError](docs/ValidationError.md)
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints do not require authorization.
## Author
all-hiro@hiro-microdatacenters.nl
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "openapi_client_gladkii",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,Template-python OpenAPI",
"author": "HIRO-MicroDataCenters",
"author_email": "all-hiro@hiro-microdatacenters.nl",
"download_url": "https://files.pythonhosted.org/packages/ac/e1/03b50e172550219755952412e7ae42131cd2e5ff98d8bf236b83725e9dff/openapi_client_gladkii-1.0.2.tar.gz",
"platform": null,
"description": "# Python client generator for OpenAPI schema\n\n## Requirements\nPython 3.7+ \nDocker engine. [Documentation](https://docs.docker.com/engine/install/)\n\n## Usage\nTo generate the client, execute the following command\n```bash\npython ./generator/generate.py <a path or URL to a .yaml file>\n```\n\nExamples:\n```bash\npython ./generator/generate.py -h\npython ./generator/generate.py https://<domain>/openapi.json\npython ./generator/generate.py https://<domain>/openapi.json --asyncio\npython ./generator/generate.py /<path>/openapi.yaml\npython ./generator/generate.py /<path>/openapi.yaml --asyncio\n```\n\n# openapi-client\nThis is a OpenAPI schema of the template-python app\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.1.0\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n\n1. If you don't have `Poetry` installed run:\n\n```bash\npip install poetry\n```\n\n2. Install dependencies:\n\n```bash\npoetry config virtualenvs.in-project true\npoetry install --no-root\n```\n\n3. Running tests:\n\n```bash\npoetry run pytest\n```\n\n4. Building package:\n\n```bash\npoetry build\n```\n\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport openapi_client\nfrom openapi_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = openapi_client.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith openapi_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = openapi_client.DefaultApi(api_client)\n\n try:\n # Example endpoint\n api_response = api_instance.example_get()\n print(\"The response of DefaultApi->example_get:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->example_get: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**example_get**](docs/DefaultApi.md#example_get) | **GET** / | Example endpoint\n*ItemsApi* | [**items_create**](docs/ItemsApi.md#items_create) | **POST** /item/ | Create an item\n*ItemsApi* | [**items_delete_item**](docs/ItemsApi.md#items_delete_item) | **DELETE** /item/{id}/ | Delete an item\n*ItemsApi* | [**items_read_all**](docs/ItemsApi.md#items_read_all) | **GET** /item/ | Read all items\n*ItemsApi* | [**items_read_item**](docs/ItemsApi.md#items_read_item) | **GET** /item/{id}/ | Read an item\n*ItemsApi* | [**items_update_item**](docs/ItemsApi.md#items_update_item) | **PUT** /item/{id}/ | Update an item\n\n\n## Documentation For Models\n\n - [ExampleResponse](docs/ExampleResponse.md)\n - [HTTPValidationError](docs/HTTPValidationError.md)\n - [Item](docs/Item.md)\n - [ValidationError](docs/ValidationError.md)\n - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n\nall-hiro@hiro-microdatacenters.nl\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Template-python OpenAPI",
"version": "1.0.2",
"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",
"template-python openapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b0b96ff174c55d13c640a45f67877de945a6e8409468f4665bdcb1e79dd9c14",
"md5": "9dcede9a9afceb65a70653c551233ffb",
"sha256": "f681c300ad88e24e2ee7cb9631a0fbbe3e28f68d9f770bd15940c7bf59bc83a3"
},
"downloads": -1,
"filename": "openapi_client_gladkii-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9dcede9a9afceb65a70653c551233ffb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 18770,
"upload_time": "2024-02-15T08:20:28",
"upload_time_iso_8601": "2024-02-15T08:20:28.894793Z",
"url": "https://files.pythonhosted.org/packages/6b/0b/96ff174c55d13c640a45f67877de945a6e8409468f4665bdcb1e79dd9c14/openapi_client_gladkii-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ace103b50e172550219755952412e7ae42131cd2e5ff98d8bf236b83725e9dff",
"md5": "01764f67d6694209fdcb65689b59e5d7",
"sha256": "89bf4e857e3a20cc749154c517e1fa2a9373c13f24510c3263321cbd848b4d59"
},
"downloads": -1,
"filename": "openapi_client_gladkii-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "01764f67d6694209fdcb65689b59e5d7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 22273,
"upload_time": "2024-02-15T08:20:30",
"upload_time_iso_8601": "2024-02-15T08:20:30.787461Z",
"url": "https://files.pythonhosted.org/packages/ac/e1/03b50e172550219755952412e7ae42131cd2e5ff98d8bf236b83725e9dff/openapi_client_gladkii-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-15 08:20:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "openapi_client_gladkii"
}
JSON
