ACRCloud client for SUISA reporting
Project description
suisa_sendemeldung
ACRCloud client that fetches data on our playout history and formats them in a CSV file format containing the data (like Track, Title and ISRC) requested by SUISA. Also takes care of sending the report to SUISA via email for hands-off operations.
Usage
We provide the SUISA Sendmeldung script as a container image or as a python package.
These usage instructions show how to install the script and how to configure it. There are different ways to run it at a schedule. We recommend using systemd-timers.
To output the scripts usage information, check out it's --help
output:
# Using Podman
podman run --rm -ti ghcr.io/radiorabe/suisasendemeldung:latest suisa_sendemeldung --help
# Using Docker
docker run --rm -ti ghcr.io/radiorabe/suisasendemeldung:latest suisa_sendemeldung --help
While we recommend running the script in it's container, you can also install the script in any python environment using pip.
We recommend using a dedicated venv for running the script hould you go down this route:
python -mvenv .venv
. venv/bin/activate
pip install suisa_sendemeldung
# Output usage after installation
suisa_sendemeldung
Configuration
You can configure this script with a configuration file (default is suisa_sendemeldung.conf
),
environment variables, or command line arguments.
Command line arguments override environment variables which themselves override settings in the configuration file.
Configuration file
The configuration files will be evaluated in the following order (last takes precedence over first):
/etc/suisa_sendemeldung.conf
$HOME/suisa_sendemeldung.conf
./suisa_sendemeldung.conf
For details on how to set configuration values, have a look at suisa_sendemeldung.conf.
Environment variables
Environment variables can also be passed as options. The relevant variables are listed in the Usage part of this document. For example run the script as follows:
podman run --rm -ti -e BEARER_TOKEN=abcdefghijklmnopqrstuvwxyzabcdef -e STREAM_ID=a-bcdefgh -e STDOUT=True ghcr.io/radiorabe/suisasendemeldung:latest suisa_sendemeldung
Command line switches
As documented in Usage, you can also pass in options on the command line as arguments. Simply run the script as follows:
podman run --rm -ti ghcr.io/radiorabe/suisasendemeldung:latest suisa_sendemeldung --bearer-token=abcdefghijklmnopqrstuvwxyzabcdef --stream_id=a-bcdefgh --stdout
Development
Snapshot testing is used to test the help output, you can update the snapshots like so:
poetry run pytest -- --snapshot-update
Release Management
At RaBe we run the script on the first and 14th of each month. Matching this we only release new versions of the script in the second half of each month.
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 twine
to publish the package to pypi. The release.yaml
action also takes care of pushing a container
image to GitHub Packages.
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 suisa_sendemeldung-0.15.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8576524977572a7c798c02836fefa91417213da281571fb915777aee3b991a22 |
|
MD5 | 76d358c8f88e9999723d06d061f193ca |
|
BLAKE2b-256 | d0ae1c7dc75d8fa74bc339c0519572928063c6fd345c4224230f15a025524c0b |
Hashes for suisa_sendemeldung-0.15.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b35dca3a2df842cc3f554a70098bd83d07f5eb4957162ca92fdc68060fdcaf47 |
|
MD5 | 59af23df49b3f0d9a92b84eb62a71d6a |
|
BLAKE2b-256 | c06b12baa0df91becedcfccea53a2a78b218bfeeae045d3b80c1e526cee69893 |