# vex-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: 0.1.0
- Package version: 1.0.0
- Generator version: 7.7.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 vex_api_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 vex_api_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import vex_api_client
from vex_api_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 = vex_api_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.
# Configure Bearer authorization: JWTBearer
configuration = vex_api_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with vex_api_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = vex_api_client.ListApi(api_client)
org_name = 'org_name_example' # str |
try:
# List Indexes
api_response = api_instance.list_indexes_v1_indexes_org_name_get(org_name)
print("The response of ListApi->list_indexes_v1_indexes_org_name_get:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ListApi->list_indexes_v1_indexes_org_name_get: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ListApi* | [**list_indexes_v1_indexes_org_name_get**](docs/ListApi.md#list_indexes_v1_indexes_org_name_get) | **GET** /v1/indexes/{org_name} | List Indexes
*SearchApi* | [**search_index_v1_search_org_name_index_name_post**](docs/SearchApi.md#search_index_v1_search_org_name_index_name_post) | **POST** /v1/search/{org_name}/{index_name} | Search Index
## Documentation For Models
- [HTTPValidationError](docs/HTTPValidationError.md)
- [IndexSearchResultEntrySchema](docs/IndexSearchResultEntrySchema.md)
- [LocationInner](docs/LocationInner.md)
- [SearchQueryBody](docs/SearchQueryBody.md)
- [SearchResponse](docs/SearchResponse.md)
- [ValidationError](docs/ValidationError.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="JWTBearer"></a>
### JWTBearer
- **Type**: Bearer authentication
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "vex-api-client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, FastAPI",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/57/81/f996f88221e9e542874299c5572a2e8486cce3b97d3e0baec62bf01333c3/vex_api_client-1.0.0.tar.gz",
"platform": null,
"description": "# vex-api-client\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.0\n- Package version: 1.0.0\n- Generator version: 7.7.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 vex_api_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 vex_api_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 vex_api_client\nfrom vex_api_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 = vex_api_client.Configuration(\n host = \"http://localhost\"\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 Bearer authorization: JWTBearer\nconfiguration = vex_api_client.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith vex_api_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = vex_api_client.ListApi(api_client)\n org_name = 'org_name_example' # str | \n\n try:\n # List Indexes\n api_response = api_instance.list_indexes_v1_indexes_org_name_get(org_name)\n print(\"The response of ListApi->list_indexes_v1_indexes_org_name_get:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling ListApi->list_indexes_v1_indexes_org_name_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*ListApi* | [**list_indexes_v1_indexes_org_name_get**](docs/ListApi.md#list_indexes_v1_indexes_org_name_get) | **GET** /v1/indexes/{org_name} | List Indexes\n*SearchApi* | [**search_index_v1_search_org_name_index_name_post**](docs/SearchApi.md#search_index_v1_search_org_name_index_name_post) | **POST** /v1/search/{org_name}/{index_name} | Search Index\n\n\n## Documentation For Models\n\n - [HTTPValidationError](docs/HTTPValidationError.md)\n - [IndexSearchResultEntrySchema](docs/IndexSearchResultEntrySchema.md)\n - [LocationInner](docs/LocationInner.md)\n - [SearchQueryBody](docs/SearchQueryBody.md)\n - [SearchResponse](docs/SearchResponse.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=\"JWTBearer\"></a>\n### JWTBearer\n\n- **Type**: Bearer authentication\n\n\n## Author\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "FastAPI",
"version": "1.0.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",
" fastapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b1d5b67516769b132dfa237003b41ebb09d340a013ef1c458bfe0971804dc48",
"md5": "26631c0f95b7e951719dc8618e35ce8b",
"sha256": "50d84564ac92418a6c765afd41afb9f33ee3b84b5fdc9ca90c71e7971cdff121"
},
"downloads": -1,
"filename": "vex_api_client-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26631c0f95b7e951719dc8618e35ce8b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 31807,
"upload_time": "2024-07-14T08:40:32",
"upload_time_iso_8601": "2024-07-14T08:40:32.309759Z",
"url": "https://files.pythonhosted.org/packages/6b/1d/5b67516769b132dfa237003b41ebb09d340a013ef1c458bfe0971804dc48/vex_api_client-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5781f996f88221e9e542874299c5572a2e8486cce3b97d3e0baec62bf01333c3",
"md5": "59fd63bfc4474785735e553cbcf51563",
"sha256": "c17be0b0bb3a2be2721688d7e23f91599a95c0e9314ca3422a16a660c51cfaae"
},
"downloads": -1,
"filename": "vex_api_client-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "59fd63bfc4474785735e553cbcf51563",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 21847,
"upload_time": "2024-07-14T08:40:33",
"upload_time_iso_8601": "2024-07-14T08:40:33.730646Z",
"url": "https://files.pythonhosted.org/packages/57/81/f996f88221e9e542874299c5572a2e8486cce3b97d3e0baec62bf01333c3/vex_api_client-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-14 08:40:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "vex-api-client"
}
JSON
