# 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)
oauth_token_post_request = rxfoundry.clients.swifty_oauth_api.OauthTokenPostRequest() # OauthTokenPostRequest |
try:
# Get a token
api_response = api_instance.oauth_token_post(oauth_token_post_request)
print("The response of OAuthApi->oauth_token_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling OAuthApi->oauth_token_post: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*OAuthApi* | [**oauth_token_post**](docs/OAuthApi.md#oauth_token_post) | **POST** /oauth/token/ | Get a token
*OAuthApi* | [**oauth_userinfo_post**](docs/OAuthApi.md#oauth_userinfo_post) | **POST** /oauth/userinfo/ | Get user info
## Documentation For Models
- [OauthTokenPostRequest](docs/OauthTokenPostRequest.md)
- [TokenResponse](docs/TokenResponse.md)
- [UserInfoResponse](docs/UserInfoResponse.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints do not require authorization.
## 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/2b/7f/f4a513b7e13149f5102881119357557e7f390f3c6587a3ae22c4c2a1a3a5/rxfoundry_clients_swifty_oauth_api-0.0.711.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 oauth_token_post_request = rxfoundry.clients.swifty_oauth_api.OauthTokenPostRequest() # OauthTokenPostRequest | \n\n try:\n # Get a token\n api_response = api_instance.oauth_token_post(oauth_token_post_request)\n print(\"The response of OAuthApi->oauth_token_post:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling OAuthApi->oauth_token_post: %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* | [**oauth_token_post**](docs/OAuthApi.md#oauth_token_post) | **POST** /oauth/token/ | Get a token\n*OAuthApi* | [**oauth_userinfo_post**](docs/OAuthApi.md#oauth_userinfo_post) | **POST** /oauth/userinfo/ | Get user info\n\n\n## Documentation For Models\n\n - [OauthTokenPostRequest](docs/OauthTokenPostRequest.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\nEndpoints do not require authorization.\n\n\n## Author\n\npaul.tindall@rxfoundry.com\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "Swifty OAuth API",
"version": "0.0.711",
"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": "f535ecab23b355fc6d5755bc287203b39a978c37dc72ab920c36b4a716ec9ae4",
"md5": "66b06671b2162f3d14e9d5a532485b71",
"sha256": "d3388c33ad54dcbdf7a560be6677bad8ea23c0711b7f5ac10be7549490402751"
},
"downloads": -1,
"filename": "rxfoundry_clients_swifty_oauth_api-0.0.711-py3-none-any.whl",
"has_sig": false,
"md5_digest": "66b06671b2162f3d14e9d5a532485b71",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 26167,
"upload_time": "2025-08-30T01:27:45",
"upload_time_iso_8601": "2025-08-30T01:27:45.997855Z",
"url": "https://files.pythonhosted.org/packages/f5/35/ecab23b355fc6d5755bc287203b39a978c37dc72ab920c36b4a716ec9ae4/rxfoundry_clients_swifty_oauth_api-0.0.711-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b7ff4a513b7e13149f5102881119357557e7f390f3c6587a3ae22c4c2a1a3a5",
"md5": "3aae2d351296474622bb29ce1dbd4f23",
"sha256": "1916b7fbb76a21b4e4c6399aa896adb2c5d1a191638ba0f7dd4b361faa71ebb9"
},
"downloads": -1,
"filename": "rxfoundry_clients_swifty_oauth_api-0.0.711.tar.gz",
"has_sig": false,
"md5_digest": "3aae2d351296474622bb29ce1dbd4f23",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 21989,
"upload_time": "2025-08-30T01:27:47",
"upload_time_iso_8601": "2025-08-30T01:27:47.163205Z",
"url": "https://files.pythonhosted.org/packages/2b/7f/f4a513b7e13149f5102881119357557e7f390f3c6587a3ae22c4c2a1a3a5/rxfoundry_clients_swifty_oauth_api-0.0.711.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-30 01:27:47",
"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
