Skip to main content

A client library for accessing aas2openapi

Project description

aas2openapi-client

A client library for accessing aas2openapi

Usage

First, create a client:

from aas2openapi_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 aas2openapi_client import AuthenticatedClient

client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")

Now call your endpoint and use your models:

from aas2openapi_client.models import MyDataModel
from aas2openapi_client.api.my_tag import get_my_data_model
from aas2openapi_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 aas2openapi_client.models import MyDataModel
from aas2openapi_client.api.my_tag import get_my_data_model
from aas2openapi_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
)

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:

  1. Every path/method combo becomes a Python module with four functions:

    1. sync: Blocking request that returns parsed data (if successful) or None
    2. sync_detailed: Blocking request that always returns a Request, optionally with parsed set if the request was successful.
    3. asyncio: Like sync but async instead of blocking
    4. asyncio_detailed: Like sync_detailed but async instead of blocking
  2. All path/query params, and bodies become method arguments.

  3. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)

  4. Any endpoint which did not have a tag will be in aas2openapi_client.api.default

Building / publishing this Client

This project uses Poetry to manage dependencies and packaging. Here are the basics:

  1. Update the metadata in pyproject.toml (e.g. authors, version)
  2. If you're using a private repository, configure it with Poetry
    1. poetry config repositories.<your-repository-name> <url-to-your-repository>
    2. poetry config http-basic.<your-repository-name> <username> <password>
  3. Publish the client with poetry publish --build -r <your-repository-name> or, if for public PyPI, just poetry publish --build

If you want to install this client into another project without publishing it (e.g. for development) then:

  1. If that project is using Poetry, you can simply do poetry add <path-to-this-client> from that project
  2. If that project is not using Poetry:
    1. Build a wheel with poetry build -f wheel
    2. Install that wheel from the other project pip install <path-to-wheel>

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

aas2openapi_client-0.2.2.tar.gz (53.0 kB view details)

Uploaded Source

Built Distribution

aas2openapi_client-0.2.2-py3-none-any.whl (224.3 kB view details)

Uploaded Python 3

File details

Details for the file aas2openapi_client-0.2.2.tar.gz.

File metadata

  • Download URL: aas2openapi_client-0.2.2.tar.gz
  • Upload date:
  • Size: 53.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.4 Windows/10

File hashes

Hashes for aas2openapi_client-0.2.2.tar.gz
Algorithm Hash digest
SHA256 2a63b3f0cb15fae55d438f70bc81e404ab2126a82fb5df5a24ee64fdbad763d0
MD5 f5519e2c01253b653e5314251da72d6b
BLAKE2b-256 94ce5c363686d76e910eefa278c80c618048c2c6912caed963cfabc0dce02f12

See more details on using hashes here.

File details

Details for the file aas2openapi_client-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for aas2openapi_client-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 51eacb766d32be0afb27e4aa1d2555cc6b12d70120f19585f55283b16b7d1769
MD5 637363191592ba9e8267fc5654fb3395
BLAKE2b-256 cfa2eb3bacf45fad2440680fc1864cc8f731746212e4fbfa22e80a49132d61f0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page