# Neops Task Engine Client
Neops workflow engine API documentation
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0
- Package version: 0.17.0
- 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 neops_task_engine_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 neops_task_engine_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import neops_task_engine_client
from neops_task_engine_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 = neops_task_engine_client.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with neops_task_engine_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = neops_task_engine_client.DefaultApi(api_client)
try:
api_instance.app_controller_get_hello()
except ApiException as e:
print("Exception when calling DefaultApi->app_controller_get_hello: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**app_controller_get_hello**](docs/DefaultApi.md#app_controller_get_hello) | **GET** / |
*DefaultApi* | [**health_controller_healthy**](docs/DefaultApi.md#health_controller_healthy) | **GET** /health |
## Documentation For Models
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints do not require authorization.
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "neops_task_engine_client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Neops Workflow Engine",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/8a/0b/d3df1117a329feb3f330100b3d121950d414082f2216b397a3589588f702/neops_task_engine_client-0.17.0.tar.gz",
"platform": null,
"description": "# Neops Task Engine Client\nNeops workflow engine API documentation\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0\n- Package version: 0.17.0\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 neops_task_engine_client\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 neops_task_engine_client\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 neops_task_engine_client\nfrom neops_task_engine_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 = neops_task_engine_client.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith neops_task_engine_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = neops_task_engine_client.DefaultApi(api_client)\n\n try:\n api_instance.app_controller_get_hello()\n except ApiException as e:\n print(\"Exception when calling DefaultApi->app_controller_get_hello: %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* | [**app_controller_get_hello**](docs/DefaultApi.md#app_controller_get_hello) | **GET** / | \n*DefaultApi* | [**health_controller_healthy**](docs/DefaultApi.md#health_controller_healthy) | **GET** /health | \n\n\n## Documentation For Models\n\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "Neops Workflow Engine",
"version": "0.17.0",
"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",
" neops workflow engine"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9ef926581e8c950529f41030bde1b52cbecc1bf2982a8e6c82b0e7d8d90ff81b",
"md5": "e311486d8eb7ad7834c5e1eb6bc3ae78",
"sha256": "b65b2cb193b86b5f26a937b5dd0b638a760e79c8ae8e7a753e78d30a562dbe14"
},
"downloads": -1,
"filename": "neops_task_engine_client-0.17.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e311486d8eb7ad7834c5e1eb6bc3ae78",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 20937,
"upload_time": "2024-10-24T14:06:54",
"upload_time_iso_8601": "2024-10-24T14:06:54.945006Z",
"url": "https://files.pythonhosted.org/packages/9e/f9/26581e8c950529f41030bde1b52cbecc1bf2982a8e6c82b0e7d8d90ff81b/neops_task_engine_client-0.17.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a0bd3df1117a329feb3f330100b3d121950d414082f2216b397a3589588f702",
"md5": "7d7d20cb34fd1d02c9a357e737c7156e",
"sha256": "9f7e188a14a1ca100476337dbb184536f839a2eb8c39c87561778668901c6a27"
},
"downloads": -1,
"filename": "neops_task_engine_client-0.17.0.tar.gz",
"has_sig": false,
"md5_digest": "7d7d20cb34fd1d02c9a357e737c7156e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 17882,
"upload_time": "2024-10-24T14:06:56",
"upload_time_iso_8601": "2024-10-24T14:06:56.054878Z",
"url": "https://files.pythonhosted.org/packages/8a/0b/d3df1117a329feb3f330100b3d121950d414082f2216b397a3589588f702/neops_task_engine_client-0.17.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-24 14:06:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "neops_task_engine_client"
}
JSON
