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 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:
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:
import reportr_backend_client
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import reportr_backend_client
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
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.EventsApi(api_client)
user_id = 'user_id_example' # str | (optional)
news_id = 56 # int | (optional)
event_type = 'event_type_example' # str | (optional)
page = 1 # int | (optional) (default to 1)
page_size = 20 # int | (optional) (default to 20)
try:
# Get Events
api_response = api_instance.get_events(user_id=user_id, news_id=news_id, event_type=event_type, page=page, page_size=page_size)
print("The response of EventsApi->get_events:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling EventsApi->get_events: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| EventsApi | get_events | GET /events/ | Get Events |
| EventsApi | insert_event | POST /events/ | Insert Event |
| NewsApi | create_news | POST /news/ | Create News |
| NewsApi | get_news | GET /news/ | Get News |
| NewsApi | get_news_by_id | GET /news/{news_id} | Get News By Id |
| StatusApi | get_health | GET /health | Health |
| StatusApi | get_readiness | GET /ready | Ready |
Documentation For Models
- EventCreate
- EventCreated
- EventRead
- HTTPValidationError
- Health
- NewsItem
- NewsItemCreated
- PaginatedResponseEventRead
- PaginatedResponseNewsItem
- Readiness
- TimeFilter
- ValidationError
- ValidationErrorLocInner
Documentation For Authorization
Authentication schemes defined for the API:
HTTPBearer
- Type: Bearer authentication
Author
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file reportr_backend_client-0.0.1741343444.tar.gz.
File metadata
- Download URL: reportr_backend_client-0.0.1741343444.tar.gz
- Upload date:
- Size: 26.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5a1860c728c76408666d85077681c578fb1b350b3534133b3ad642c00c2b1b5a
|
|
| MD5 |
1a8767a0e3b237b9dfd9fd7094baa1b9
|
|
| BLAKE2b-256 |
874f4a99669610e09f8aebbeca70be5533300d7d8bdafa85445daef46a66e0f5
|
Provenance
The following attestation bundles were made for reportr_backend_client-0.0.1741343444.tar.gz:
Publisher:
publish-client.yml on reportr-news/backend
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
reportr_backend_client-0.0.1741343444.tar.gz -
Subject digest:
5a1860c728c76408666d85077681c578fb1b350b3534133b3ad642c00c2b1b5a - Sigstore transparency entry: 178523038
- Sigstore integration time:
-
Permalink:
reportr-news/backend@352a168212ddff79e9196adf04fad4d9c18c8052 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/reportr-news
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-client.yml@352a168212ddff79e9196adf04fad4d9c18c8052 -
Trigger Event:
push
-
Statement type:
File details
Details for the file reportr_backend_client-0.0.1741343444-py3-none-any.whl.
File metadata
- Download URL: reportr_backend_client-0.0.1741343444-py3-none-any.whl
- Upload date:
- Size: 45.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d07ee7fb3b7489b129cae85db2fe0a2432422a07b38f918f536d245201c3dca1
|
|
| MD5 |
1ff30bd7f856ccdd33ac612baff78d87
|
|
| BLAKE2b-256 |
62716face5769f7343c112e227c3741fb78a7a501eb55d34e83123a65a4ac84e
|
Provenance
The following attestation bundles were made for reportr_backend_client-0.0.1741343444-py3-none-any.whl:
Publisher:
publish-client.yml on reportr-news/backend
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
reportr_backend_client-0.0.1741343444-py3-none-any.whl -
Subject digest:
d07ee7fb3b7489b129cae85db2fe0a2432422a07b38f918f536d245201c3dca1 - Sigstore transparency entry: 178523039
- Sigstore integration time:
-
Permalink:
reportr-news/backend@352a168212ddff79e9196adf04fad4d9c18c8052 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/reportr-news
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-client.yml@352a168212ddff79e9196adf04fad4d9c18c8052 -
Trigger Event:
push
-
Statement type:
