bssclient 0.3.1

Fully typed, async client library for Basic Supply Service (BSS)

bssclient.py

This repository contains the package bssclient. It is an async, fully typed Python client for the Basic Supply Service (BSS).

Its features are handwritten and extended as we need them. So it is not autogenerated from the BSS OpenAPI.

Installation

Install it from PyPI:

pip install bssclient

Usage

from yarl import URL
from bssclient import bssclient, BssConfig

bss_config = BssConfig(
    server_url=URL("https://my-bss.xtk-test.org/"),
    usr="my-usr",
    pwd="my-pwd",
)
client = bssclient(bss_config)
ermittlungsauftraege = await client.get_all_ermittlungsauftraege()

Even though we did not fully replicate the BSS data model, we tried to make the client as flexible as possible. You can use any unmapped field returned by TMDS by using the model_extra property of pydantic.

Development

For development of this library, follow the instructions in our Python Template Repository. tl;dr: tox -e dev will set up a development environment for you.

Release (CI/CD)

To release a new version of this library, create a new release in GitHub. Make sure its tag starts with v and the version number, e.g. v1.2.3. Releases are not restricted to the main branch, but we prefer them to happen there.

Contribute

You are very welcome to contribute to this template repository by opening a pull request against the main branch.