A client library for accessing Compute API
Project description
compute-api-client
A client library for accessing Compute API
Usage
First, create a client. Since Compute requires authentication, use AuthenticatedClient
class
from compute_api_client import AuthenticatedClient
client = AuthenticatedClient(base_url="http://compute-api:8000", token="SuperSecretToken")
Now we call Compute and get the list of Plugins:
from compute_api_client.models import Plugin
from compute_api_client.api.plugin_controller import plugin_controller_find
from compute_api_client.types import Response
response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
Or do the same thing with an async version:
from compute_api_client.models import Plugin
from compute_api_client.api.plugin_controller import plugin_controller_find
from compute_api_client.types import Response
response: Response[MyDataModel] = await get_my_data_model.sync_detailed(client=client)
There are more settings on the generated Client
class which let you control more runtime behavior, check out the docstring on that class for more info.
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 async instead of blockingasyncio_detailed
: Likesync_detailed
but 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
compute_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
Release history Release notifications | RSS feed
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 compute_api_client-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31b74a1c09a8e40475fd2e9946e5a7a5d8813b3fee2871bc2847b9a447b7a7b7 |
|
MD5 | 6744d4a3fba7c105b1dd07c9942b3ba9 |
|
BLAKE2b-256 | bbfa43e566821fcbc465f4f499ab83933082e7856297cc246fa886ca07558c91 |