sadales-tikls-m2m 1.0.0

A client library for accessing Sadales Tikls M2M API

sadales-tikls-m2m-api-client

A client library for accessing Sadales Tikls M2M API

OpenAPI

See preview in Swagger Editor online.

Keep in mind that direct queries from browser won't work due to known CORS issue.

Usage

First, create a client:

from sadales_tikls_m2m_api_client import AuthenticatedClient

client = AuthenticatedClient(base_url="https://services.e-st.lv/m2m", token="SuperSecretToken")

Now call your endpoint and use your models:

from sadales_tikls_m2m_api_client import AuthenticatedClient
from sadales_tikls_m2m_api_client.types import Response
from sadales_tikls_m2m_api_client.api.default import get_object_list
from sadales_tikls_m2m_api_client.models import GetObjectListResponse200

objects: GetObjectListResponse200 = get_object_list.sync(client=client)
# or if you need more info (e.g. status_code)
response: Response[GetObjectListResponse200] = get_object_list.sync_detailed(client=client)

Or do the same thing with an async version:

from sadales_tikls_m2m_api_client import AuthenticatedClient
from sadales_tikls_m2m_api_client.types import Response
from sadales_tikls_m2m_api_client.api.default import get_object_list
from sadales_tikls_m2m_api_client.models import GetObjectListResponse200

my_data: GetObjectListResponse200 = await get_object_list.asyncio(client=client)
response: Response[GetObjectListResponse200] = await get_object_list.asyncio_detailed(client=client)

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 the async instead of blocking
   4. asyncio_detailed: Like sync_detailed by 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 sadales_tikls_m2m_api_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>