Verzeichnisdienst Python Models
This package provides mostly autogenerated pydantic-based model classes for the Verzeichnisdienst API.
It does not provide you with an HTTP client.
Installation
Install it from PyPI
pip install verzeichnisdienst
Then use it:
from verzeichnisdienst.v1.models import ApiRecord
my_json = {
"providerId": "1234567890123",
"apiId": "example",
"majorVersion": 1,
"url": "https://www.example.org/api/resource/v1",
"additionalMetadata": None,
"lastUpdated": "2024-10-01T00:00:00+00:00",
"revision": 1,
"status": "Test",
}
my_strongly_typed_record = ApiRecord.model_validate(my_json)
or
from verzeichnisdienst.v1.websocket import Contact
my_json_contact = {
"email": "verzeichnis@hochfrequenz.de",
"phone": "0049123457890"
}
my_strongly_typed_contact = Contact.model_validate(my_json_contact)
See the tests for more examples.
Project Structure
This project is based on datamodel-code-generator.
Most of the classes are autogenerated from the openapi.yml which can be found on SwaggerHub.
After updating the openapi.yml file, use
tox -e codegen
to re-generate the model classes.
Contribute
You are very welcome to contribute to this template repository by opening a pull request against the main branch.
Metadata
Release files for verzeichnisdienst 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| verzeichnisdienst-0.1.0.tar.gz | 26.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| verzeichnisdienst-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 34.3 kB
Release files / verzeichnisdienst-0.1.0.tar.gz
| Download URL | verzeichnisdienst-0.1.0.tar.gz |
|---|---|
| Size | 26.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fd3a663221f8a69d4b4bc3f967b2a79224a447b0f4e288965de3682442c82eaf
|
|
BLAKE2b-256 checksum How to use checksums |
2c9a0ceb2125602d3e6eaae669f58f5636cc77e3092b8299836db396807d84d3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 18, 2024.
Transparency logRelease files / verzeichnisdienst-0.1.0-py3-none-any.whl
| Download URL | verzeichnisdienst-0.1.0-py3-none-any.whl |
|---|---|
| Size | 7.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
455a88bc665565dab1d2229dfcee9a3dc35b0068fd320531cc7529e213704297
|
|
BLAKE2b-256 checksum How to use checksums |
f1af16acaeca582fcce7c48d5149ca162b01e106a5c32d811dccbcea16c8dc1e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 18, 2024.
Transparency log