{"id":22643152,"url":"https://github.com/hochfrequenz/verzeichnisdienst-python-models","last_synced_at":"2025-04-11T23:22:53.796Z","repository":{"id":263405977,"uuid":"888939227","full_name":"Hochfrequenz/verzeichnisdienst-python-models","owner":"Hochfrequenz","description":"Pydantic Model Classes for the EDI@Energy Verzeichnisdienst API","archived":false,"fork":false,"pushed_at":"2025-04-07T09:57:02.000Z","size":62,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-07T10:33:53.710Z","etag":null,"topics":["api","bdew","codegen","edi-energy","energiewirtschaft","verzeichnisdienst"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Hochfrequenz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-15T09:47:09.000Z","updated_at":"2025-04-07T09:55:56.000Z","dependencies_parsed_at":"2024-11-18T11:56:20.474Z","dependency_job_id":"c1c871e3-f411-45e8-b648-dcbd4844349d","html_url":"https://github.com/Hochfrequenz/verzeichnisdienst-python-models","commit_stats":null,"previous_names":["hochfrequenz/verzeichnisdienst-python-models"],"tags_count":3,"template":false,"template_full_name":"Hochfrequenz/python_template_repository","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hochfrequenz%2Fverzeichnisdienst-python-models","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hochfrequenz%2Fverzeichnisdienst-python-models/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hochfrequenz%2Fverzeichnisdienst-python-models/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hochfrequenz%2Fverzeichnisdienst-python-models/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Hochfrequenz","download_url":"https://codeload.github.com/Hochfrequenz/verzeichnisdienst-python-models/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247640153,"owners_count":20971549,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","bdew","codegen","edi-energy","energiewirtschaft","verzeichnisdienst"],"created_at":"2024-12-09T05:09:30.567Z","updated_at":"2025-04-11T23:22:53.765Z","avatar_url":"https://github.com/Hochfrequenz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Verzeichnisdienst Python Models\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n![Python Versions (officially) supported](https://img.shields.io/pypi/pyversions/verzeichnisdienst.svg)\n![Pypi status badge](https://img.shields.io/pypi/v/verzeichnisdienst)\n![Unittests status badge](https://github.com/Hochfrequenz/malo-ident-python-models/workflows/Unittests/badge.svg)\n![Coverage status badge](https://github.com/Hochfrequenz/malo-ident-python-models/workflows/Coverage/badge.svg)\n![Linting status badge](https://github.com/Hochfrequenz/malo-ident-python-models/workflows/Linting/badge.svg)\n![Black status badge](https://github.com/Hochfrequenz/malo-ident-python-models/workflows/Formatting/badge.svg)\n\nThis package provides mostly autogenerated [pydantic](https://docs.pydantic.dev/latest/)-based model classes for the Verzeichnisdienst API.\n\nIt does not provide you with an HTTP client.\n\n## Installation\n\nInstall it from [PyPI](https://pypi.org/project/verzeichnisdienst)\n\n```bash\npip install verzeichnisdienst\n```\n\nThen use it:\n\n```python\nfrom verzeichnisdienst.v1.models import ApiRecord\n\nmy_json = {\n    \"providerId\": \"1234567890123\",\n    \"apiId\": \"example\",\n    \"majorVersion\": 1,\n    \"url\": \"https://www.example.org/api/resource/v1\",\n    \"additionalMetadata\": None,\n    \"lastUpdated\": \"2024-10-01T00:00:00+00:00\",\n    \"revision\": 1,\n    \"status\": \"Test\",\n}\nmy_strongly_typed_record = ApiRecord.model_validate(my_json)\n```\n\nor\n\n```python\nfrom verzeichnisdienst.v1.websocket import Contact\n\nmy_json_contact = {\n    \"email\": \"verzeichnis@hochfrequenz.de\",\n    \"phone\": \"0049123457890\"\n}\nmy_strongly_typed_contact = Contact.model_validate(my_json_contact)\n```\n\nSee the [tests](unittests/test_models.py) for more examples.\n\n## Project Structure\n\nThis project is based on [`datamodel-code-generator`](https://github.com/koxudaxi/datamodel-code-generator/).\nMost of the classes are autogenerated from the [`openapi.yml`](openapi/v1/openapi.yml) which can be found on [SwaggerHub](https://app.swaggerhub.com/apis-docs/edi_energy/Verzeichnisdienst_Web-API_2024_10_01/1.0.0).\n\nAfter updating the `openapi.yml` file, use\n\n```bash\ntox -e codegen\n```\n\nto re-generate the model classes.\n\n## Contribute\n\nYou are very welcome to contribute to this template repository by opening a pull request against the main branch.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhochfrequenz%2Fverzeichnisdienst-python-models","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhochfrequenz%2Fverzeichnisdienst-python-models","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhochfrequenz%2Fverzeichnisdienst-python-models/lists"}