Skip to main content

bssclient.py

License: MIT Python Versions (officially) supported Pypi status badge Unittests status badge Coverage status badge Linting status badge Black status badge

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: uv sync --group 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bssclient-0.3.2.tar.gz (118.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bssclient-0.3.2-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

Details for the file bssclient-0.3.2.tar.gz.

File metadata

  • Download URL: bssclient-0.3.2.tar.gz
  • Upload date:
  • Size: 118.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for bssclient-0.3.2.tar.gz
Algorithm Hash digest
SHA256 ca460c402f49e26ffa8ae089208edf807fd57c7e48eac69fb1bce6b6bffeb219
MD5 68a3fa450e7c8cc079ae13ae2d4dd501
BLAKE2b-256 5bae50d66947fd3c6a6ff2ad54566b250de0c12aac3ba20525330f5ad6ca1d69

See more details on using hashes here.

File details

Details for the file bssclient-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: bssclient-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 13.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for bssclient-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e577f0467012eacad87c994f641fbb2a401358ffab9580baa97da97afe649205
MD5 4d706a4d4c647baace9e8599bbf0348c
BLAKE2b-256 8477cd88608a816e7cf4e69551b846690f778b875d4f52b1a454f2ebf76ef4a0

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.3.2 This release

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page