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.

Metadata

Release files for bssclient 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bssclient 0.3.2
File Size Uploaded Provenance
bssclient-0.3.2.tar.gz 118.2 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for bssclient 0.3.2
File Interpreter ABI Platform
bssclient-0.3.2-py3-none-any.whl Python 3 none any Details

Total release size: 131.8 kB

Release files / bssclient-0.3.2.tar.gz

Download URL bssclient-0.3.2.tar.gz
Size 118.2 kB
Tags Source
SHA-256 checksum
How to use checksums
ca460c402f49e26ffa8ae089208edf807fd57c7e48eac69fb1bce6b6bffeb219
BLAKE2b-256 checksum
How to use checksums
5bae50d66947fd3c6a6ff2ad54566b250de0c12aac3ba20525330f5ad6ca1d69
Upload date
Uploaded using Trusted Publishing?
What is 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}

Release files / bssclient-0.3.2-py3-none-any.whl

Download URL bssclient-0.3.2-py3-none-any.whl
Size 13.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e577f0467012eacad87c994f641fbb2a401358ffab9580baa97da97afe649205
BLAKE2b-256 checksum
How to use checksums
8477cd88608a816e7cf4e69551b846690f778b875d4f52b1a454f2ebf76ef4a0
Upload date
Uploaded using Trusted Publishing?
What is 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}

Security for bssclient 0.3.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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