A client library for accessing CloudReactor API
Project description
cloudreactor-python-api-client
A client library for accessing CloudReactor API
Usage
First, create a client:
from cloudreactor-python_api_client import Client
client = Client(base_url="https://api.example.com")
If the endpoints you're going to hit require authentication, use AuthenticatedClient
instead:
from cloudreactor-python_api_client import AuthenticatedClient
client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
Now call your endpoint and use your models:
from cloudreactor-python_api_client.models import MyDataModel
from cloudreactor-python_api_client.api.my_tag import get_my_data_model
from cloudreactor-python_api_client.types import Response
my_data: MyDataModel = get_my_data_model.sync(client=client)
# or if you need more info (e.g. status_code)
response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
Or do the same thing with an async version:
from cloudreactor-python_api_client.models import MyDataModel
from cloudreactor-python_api_client.api.my_tag import get_my_data_model
from cloudreactor-python_api_client.types import Response
my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
client = AuthenticatedClient(
base_url="https://internal_api.example.com",
token="SuperSecretToken",
verify_ssl="/path/to/certificate_bundle.pem",
)
You can also disable certificate validation altogether, but beware that this is a security risk.
client = AuthenticatedClient(
base_url="https://internal_api.example.com",
token="SuperSecretToken",
verify_ssl=False
)
Things to know:
-
Every path/method combo becomes a Python module with four functions:
sync
: Blocking request that returns parsed data (if successful) orNone
sync_detailed
: Blocking request that always returns aRequest
, optionally withparsed
set if the request was successful.asyncio
: Likesync
but the async instead of blockingasyncio_detailed
: Likesync_detailed
by async instead of blocking
-
All path/query params, and bodies become method arguments.
-
If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
-
Any endpoint which did not have a tag will be in
cloudreactor-python_api_client.api.default
Building / publishing this Client
This project uses Poetry to manage dependencies and packaging. Here are the basics:
- Update the metadata in pyproject.toml (e.g. authors, version)
- If you're using a private repository, configure it with Poetry
poetry config repositories.<your-repository-name> <url-to-your-repository>
poetry config http-basic.<your-repository-name> <username> <password>
- Publish the client with
poetry publish --build -r <your-repository-name>
or, if for public PyPI, justpoetry publish --build
If you want to install this client into another project without publishing it (e.g. for development) then:
- If that project is using Poetry, you can simply do
poetry add <path-to-this-client>
from that project - If that project is not using Poetry:
- Build a wheel with
poetry build -f wheel
- Install that wheel from the other project
pip install <path-to-wheel>
- Build a wheel with
Project details
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
Hashes for cloudreactor-api-client-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 023aa86cc73a303bb14fb17955ab2667dc569adce83cd0928b9c49c03ca8b782 |
|
MD5 | 3c5984154969cd990ae040678fb361a6 |
|
BLAKE2b-256 | 2bf4ef51e4a00809279fff4b86cfd147dc637498bd21f9b4075df4ccf4cd1c5f |
Hashes for cloudreactor_api_client-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ef86027de272eb7a9a9234ca7c77444efe10301a32437f10bcd53a2590524e2 |
|
MD5 | c053d0b4656bc57499f90ec0084730e5 |
|
BLAKE2b-256 | 62794567488f311cfe3df4a2cb30cba84d4983f72e3dd37568abb1016579a34d |