# rxfoundry.clients.swifty-oauth-api
API for the Swifty OAuth Backend
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
- Generator version: 7.13.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.9+
## 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 rxfoundry.clients.swifty_oauth_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 rxfoundry.clients.swifty_oauth_api
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import rxfoundry.clients.swifty_oauth_api
from rxfoundry.clients.swifty_oauth_api.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 = rxfoundry.clients.swifty_oauth_api.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with rxfoundry.clients.swifty_oauth_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = rxfoundry.clients.swifty_oauth_api.OAuthApi(api_client)
get_token_request = rxfoundry.clients.swifty_oauth_api.GetTokenRequest() # GetTokenRequest |
try:
# Get a token
api_response = api_instance.get_token(get_token_request)
print("The response of OAuthApi->get_token:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling OAuthApi->get_token: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*OAuthApi* | [**get_token**](docs/OAuthApi.md#get_token) | **POST** /oauth/token/ | Get a token
*OAuthApi* | [**get_user_info**](docs/OAuthApi.md#get_user_info) | **POST** /oauth/userinfo/ | Get user info
## Documentation For Models
- [GetTokenRequest](docs/GetTokenRequest.md)
- [TokenResponse](docs/TokenResponse.md)
- [UserInfoResponse](docs/UserInfoResponse.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="opaque_token"></a>
### opaque_token
- **Type**: Bearer authentication (opaque)
## Author
paul.tindall@rxfoundry.com
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "rxfoundry.clients.swifty_oauth_api",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Swifty OAuth API",
"author": "RxFoundry Team",
"author_email": "paul.tindall@rxfoundry.com",
"download_url": "https://files.pythonhosted.org/packages/ae/03/43a1edd0cec66b7bf2c4352dfd341f1ba3ed5cf9e35e9f0b6ed776b3c56c/rxfoundry_clients_swifty_oauth_api-0.0.899.tar.gz",
"platform": null,
"description": "# rxfoundry.clients.swifty-oauth-api\nAPI for the Swifty OAuth Backend\n\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\n- Generator version: 7.13.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.9+\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 rxfoundry.clients.swifty_oauth_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 rxfoundry.clients.swifty_oauth_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 rxfoundry.clients.swifty_oauth_api\nfrom rxfoundry.clients.swifty_oauth_api.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 = rxfoundry.clients.swifty_oauth_api.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith rxfoundry.clients.swifty_oauth_api.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = rxfoundry.clients.swifty_oauth_api.OAuthApi(api_client)\n get_token_request = rxfoundry.clients.swifty_oauth_api.GetTokenRequest() # GetTokenRequest | \n\n try:\n # Get a token\n api_response = api_instance.get_token(get_token_request)\n print(\"The response of OAuthApi->get_token:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling OAuthApi->get_token: %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*OAuthApi* | [**get_token**](docs/OAuthApi.md#get_token) | **POST** /oauth/token/ | Get a token\n*OAuthApi* | [**get_user_info**](docs/OAuthApi.md#get_user_info) | **POST** /oauth/userinfo/ | Get user info\n\n\n## Documentation For Models\n\n - [GetTokenRequest](docs/GetTokenRequest.md)\n - [TokenResponse](docs/TokenResponse.md)\n - [UserInfoResponse](docs/UserInfoResponse.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=\"opaque_token\"></a>\n### opaque_token\n\n- **Type**: Bearer authentication (opaque)\n\n\n## Author\n\npaul.tindall@rxfoundry.com\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "Swifty OAuth API",
"version": "0.0.899",
"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",
" swifty oauth api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "46c7b9e7d700e70708afcfa1cb1b62b434e0d96e61d5e11fe2bc15617a82e451",
"md5": "f14e3bc73beb8075db9465d5b0fd1223",
"sha256": "2e665092a413ebc1813585e9e39ef7b6f018c36f6df579177ae8b1391979d443"
},
"downloads": -1,
"filename": "rxfoundry_clients_swifty_oauth_api-0.0.899-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f14e3bc73beb8075db9465d5b0fd1223",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 27739,
"upload_time": "2025-10-29T21:22:33",
"upload_time_iso_8601": "2025-10-29T21:22:33.945953Z",
"url": "https://files.pythonhosted.org/packages/46/c7/b9e7d700e70708afcfa1cb1b62b434e0d96e61d5e11fe2bc15617a82e451/rxfoundry_clients_swifty_oauth_api-0.0.899-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ae0343a1edd0cec66b7bf2c4352dfd341f1ba3ed5cf9e35e9f0b6ed776b3c56c",
"md5": "e794de9e97249446bcab87eb516e01f6",
"sha256": "72abd5cac69e2ce664ba084879df762ca6ebd0fff5ca95628e904e2837776e9c"
},
"downloads": -1,
"filename": "rxfoundry_clients_swifty_oauth_api-0.0.899.tar.gz",
"has_sig": false,
"md5_digest": "e794de9e97249446bcab87eb516e01f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 22395,
"upload_time": "2025-10-29T21:22:35",
"upload_time_iso_8601": "2025-10-29T21:22:35.159993Z",
"url": "https://files.pythonhosted.org/packages/ae/03/43a1edd0cec66b7bf2c4352dfd341f1ba3ed5cf9e35e9f0b6ed776b3c56c/rxfoundry_clients_swifty_oauth_api-0.0.899.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-29 21:22:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "rxfoundry.clients.swifty_oauth_api"
}
JSON
