Python dataclasses for radioplayer generated from XSD
Project description
Python Radioplayer Dataclasses
Classes for generating radioplayer compatible data. Generated using xsdata.
Installation
pip install radioplayer-dataclasses
Usage
The radioplayer.dataclasses
module may be used to build radioplayer compatible structures.
Serializing is done using the xsdata
library.
>>> from radioplayer.dataclasses import *
>>> epg = Epg(lang="en")
>>> epg
Epg(programme_groups=[], schedule=[], alternate_source=[], lang='en', system=<SystemType.DAB: 'DAB'>)
>>> from xsdata.formats.dataclass.serializers import XmlSerializer
>>> from xsdata.formats.dataclass.serializers.config import SerializerConfig
>>>
>>> config = SerializerConfig(
... pretty_print=True,
... xml_declaration=False,
... )
>>> serializer = XmlSerializer(config=config)
>>> xml = serializer.render(epg, ns_map={None: Epg.Meta.namespace})
>>> print(xml.strip())
<epg xmlns="http://www.radioplayer.co.uk/schemas/11/epgSchedule" xml:lang="en" system="DAB"/>
Additional examples are available in the tests/
directory.
Development
Getting Started
# setup a dev env
python -mvenv env
. env/bin/activate
# install a modern poetry version
python -mpip install 'poetry>=1.2.0'
# install deps and dev version
poetry install
Loading XSD files
mkdir schemas
pushd schemas/
curl -L -O http://www.w3.org/2001/xml.xsd
curl -L -O https://radioplayer.co.uk/schemas/11/epgSchedule_11.xsd
curl -L -O https://radioplayer.co.uk/schemas/11/epgDataTypes_11.xsd
curl -L -O https://radioplayer.co.uk/schemas/11/rpDataTypes_11.xsd
curl -L -O https://radioplayer.co.uk/schemas/11/epgSI_11.xsd
popd
Some touchups where made to the files to make them validate where necessary.
Generating dataclasses
poetry run xsdata -c .xsdata.xml schemas/
Running tests
poetry run pytest
Release Management
The CI/CD setup uses semantic commit messages following the conventional commits standard. There is a GitHub Action in .github/workflows/semantic-release.yaml that uses go-semantic-commit to create new releases.
The commit message should be structured as follows:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
The commit contains the following structural elements, to communicate intent to the consumers of your library:
- fix: a commit of the type
fix
patches gets released with a PATCH version bump - feat: a commit of the type
feat
gets released as a MINOR version bump - BREAKING CHANGE: a commit that has a footer
BREAKING CHANGE:
gets released as a MAJOR version bump - types other than
fix:
andfeat:
are allowed and don't trigger a release
If a commit does not contain a conventional commit style message you can fix it during the squash and merge operation on the PR.
Once a commit has landed on the main
branch a release will be created and automatically published to pypi
using the GitHub Action in .github/workflows/release.yaml which uses poetry
to publish the package to pypi.
License
This application is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.
Copyright
Copyright (c) 2022 Radio Bern RaBe
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for radioplayer_dataclasses-0.5.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 800018795a8cf02592b702eec0120b0002d56495f7b08eb41a6172a567cd7d87 |
|
MD5 | ac9984b66f1f9871a6601278a4f54bb1 |
|
BLAKE2b-256 | 7a2c43fdfdb652e1fb5a30d76f302698bc60c080faf5c6c3f673538feb22e488 |
Hashes for radioplayer_dataclasses-0.5.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8d0899f6d303c7986a9edbe1e2e620c65644a88cb9e0e2d8f4bbd7bf6447341 |
|
MD5 | 6c2f1ad6203bac4fd671fa29c1092221 |
|
BLAKE2b-256 | 5dc1dd0750c4bde052b752231ab2ff179aa07d6a8b8ea10f58633afea4bebfee |