# reportr-backend-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.13.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.8+
## 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 reportr_backend_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 reportr_backend_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import reportr_backend_client
from reportr_backend_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 = reportr_backend_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: HTTPBearer
configuration = reportr_backend_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with reportr_backend_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = reportr_backend_client.NewsApi(api_client)
create_news_item = reportr_backend_client.CreateNewsItem() # CreateNewsItem |
try:
# Create News
api_response = api_instance.create_news(create_news_item)
print("The response of NewsApi->create_news:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling NewsApi->create_news: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*NewsApi* | [**create_news**](docs/NewsApi.md#create_news) | **POST** /news/ | Create News
*NewsApi* | [**get_news**](docs/NewsApi.md#get_news) | **GET** /news/ | Get News
*NewsApi* | [**get_news_by_id**](docs/NewsApi.md#get_news_by_id) | **GET** /news/{news_id} | Get News By Id
*StatusApi* | [**get_health**](docs/StatusApi.md#get_health) | **GET** /health | Health
*StatusApi* | [**get_readiness**](docs/StatusApi.md#get_readiness) | **GET** /ready | Ready
## Documentation For Models
- [CreateNewsItem](docs/CreateNewsItem.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [NewsItemCreated](docs/NewsItemCreated.md)
- [NewsItemResponse](docs/NewsItemResponse.md)
- [PaginatedNewsResponse](docs/PaginatedNewsResponse.md)
- [Status](docs/Status.md)
- [TimeFilter](docs/TimeFilter.md)
- [ValidationError](docs/ValidationError.md)
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="HTTPBearer"></a>
### HTTPBearer
- **Type**: Bearer authentication
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "reportr-backend-client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, backend",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/95/aa/b063cfc549155c9035b1fa1416a950cc4c8ba6172109b2f669c0c0ac35e9/reportr_backend_client-0.0.1740749745.tar.gz",
"platform": null,
"description": "# reportr-backend-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.13.0-SNAPSHOT\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.8+\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 reportr_backend_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 reportr_backend_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 reportr_backend_client\nfrom reportr_backend_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 = reportr_backend_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: HTTPBearer\nconfiguration = reportr_backend_client.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith reportr_backend_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = reportr_backend_client.NewsApi(api_client)\n create_news_item = reportr_backend_client.CreateNewsItem() # CreateNewsItem | \n\n try:\n # Create News\n api_response = api_instance.create_news(create_news_item)\n print(\"The response of NewsApi->create_news:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling NewsApi->create_news: %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*NewsApi* | [**create_news**](docs/NewsApi.md#create_news) | **POST** /news/ | Create News\n*NewsApi* | [**get_news**](docs/NewsApi.md#get_news) | **GET** /news/ | Get News\n*NewsApi* | [**get_news_by_id**](docs/NewsApi.md#get_news_by_id) | **GET** /news/{news_id} | Get News By Id\n*StatusApi* | [**get_health**](docs/StatusApi.md#get_health) | **GET** /health | Health\n*StatusApi* | [**get_readiness**](docs/StatusApi.md#get_readiness) | **GET** /ready | Ready\n\n\n## Documentation For Models\n\n - [CreateNewsItem](docs/CreateNewsItem.md)\n - [HTTPValidationError](docs/HTTPValidationError.md)\n - [NewsItemCreated](docs/NewsItemCreated.md)\n - [NewsItemResponse](docs/NewsItemResponse.md)\n - [PaginatedNewsResponse](docs/PaginatedNewsResponse.md)\n - [Status](docs/Status.md)\n - [TimeFilter](docs/TimeFilter.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\n\nAuthentication schemes defined for the API:\n<a id=\"HTTPBearer\"></a>\n### HTTPBearer\n\n- **Type**: Bearer authentication\n\n\n## Author\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "backend",
"version": "0.0.1740749745",
"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",
" backend"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8f06699507367515030c79628a26aee0e80fe4d01e9e9f05dac46cbfbc860911",
"md5": "0bebd1aef04e1a02f1a5771b2eb17d51",
"sha256": "319e4f8bb33210032a57708cc8887e2421fb0a5317679abdbe7a9e3605a8c577"
},
"downloads": -1,
"filename": "reportr_backend_client-0.0.1740749745-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0bebd1aef04e1a02f1a5771b2eb17d51",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 37951,
"upload_time": "2025-02-28T13:35:58",
"upload_time_iso_8601": "2025-02-28T13:35:58.679722Z",
"url": "https://files.pythonhosted.org/packages/8f/06/699507367515030c79628a26aee0e80fe4d01e9e9f05dac46cbfbc860911/reportr_backend_client-0.0.1740749745-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "95aab063cfc549155c9035b1fa1416a950cc4c8ba6172109b2f669c0c0ac35e9",
"md5": "5cf9fcf05ec089ab2835291242c785ba",
"sha256": "f4d6b4fa9f4b75f666c8a1438796d32a4e54b539806244d47b46f66a0e4c0d6d"
},
"downloads": -1,
"filename": "reportr_backend_client-0.0.1740749745.tar.gz",
"has_sig": false,
"md5_digest": "5cf9fcf05ec089ab2835291242c785ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 25229,
"upload_time": "2025-02-28T13:36:00",
"upload_time_iso_8601": "2025-02-28T13:36:00.753293Z",
"url": "https://files.pythonhosted.org/packages/95/aa/b063cfc549155c9035b1fa1416a950cc4c8ba6172109b2f669c0c0ac35e9/reportr_backend_client-0.0.1740749745.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-28 13:36:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "reportr-backend-client"
}
JSON
