# 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](https://www.freedesktop.org/software/systemd/man/latest/systemd.timer.html).
To output the scripts usage information, check out it's `--help` output:
```bash
# 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](https://pip.pypa.io/).
We recommend using a dedicated [venv](https://docs.python.org/3/library/venv.html) for
running the script hould you go down this route:
```bash
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):
1. `/etc/suisa_sendemeldung.conf`
2. `$HOME/suisa_sendemeldung.conf`
3. `./suisa_sendemeldung.conf`
For details on how to set configuration values, have a look at [suisa_sendemeldung.conf](etc/suisa_sendemeldung.conf).
#### Environment variables
Environment variables can also be passed as options. The relevant variables are listed in the [Usage](#Usage) part of this document. For example run the script as follows:
```bash
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](#Usage), you can also pass in options on the command line as arguments. Simply run the script as follows:
```bash
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](https://www.conventionalcommits.org/en/v1.0.0/).
There is a GitHub Action in [.github/workflows/semantic-release.yaml](./.github/workflows/semantic-release.yaml)
that uses [go-semantic-commit](https://go-semantic-release.xyz/) 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:
1. **fix:** a commit of the type `fix` patches gets released with a PATCH version bump
1. **feat:** a commit of the type `feat` gets released as a MINOR version bump
1. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:` gets released as a MAJOR version bump
1. types other than `fix:` and `feat:` 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](https://pypi.org/)
using the GitHub Action in [.github/workflows/release.yaml](./.github/workflows/reliease.yaml) which uses [twine](https://twine.readthedocs.io/)
to publish the package to pypi. The `release.yaml` action also takes care of pushing a [container](https://opencontainers.org/)
image to [GitHub Packages](https://github.com/features/packages).
Raw data
{
"_id": null,
"home_page": "http://github.com/radiorabe/suisa_reporting",
"name": "suisa_sendemeldung",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "RaBe IT-Reaktion",
"author_email": "it@rabe.ch",
"download_url": "https://files.pythonhosted.org/packages/95/da/32875371860d4e9141ad656f28c1ec04b48a6b5ba77ca9ec93aa8252433f/suisa_sendemeldung-0.16.0.tar.gz",
"platform": null,
"description": "# suisa_sendemeldung\n\nACRCloud 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.\n\n## Usage\n\nWe provide the SUISA Sendmeldung script as a container image or as a python package.\n\nThese usage instructions show how to install the script and how to configure it.\nThere are different ways to run it at a schedule. We recommend using\n[systemd-timers](https://www.freedesktop.org/software/systemd/man/latest/systemd.timer.html).\n\nTo output the scripts usage information, check out it's `--help` output:\n\n```bash\n# Using Podman\npodman run --rm -ti ghcr.io/radiorabe/suisasendemeldung:latest suisa_sendemeldung --help\n\n# Using Docker\ndocker run --rm -ti ghcr.io/radiorabe/suisasendemeldung:latest suisa_sendemeldung --help\n```\n\nWhile we recommend running the script in it's container, you can also install the script\nin any python environment using [pip](https://pip.pypa.io/).\n\nWe recommend using a dedicated [venv](https://docs.python.org/3/library/venv.html) for\nrunning the script hould you go down this route:\n\n```bash\npython -mvenv .venv\n. venv/bin/activate\n\npip install suisa_sendemeldung\n\n# Output usage after installation\nsuisa_sendemeldung\n```\n### Configuration\n\nYou can configure this script with a configuration file (default is `suisa_sendemeldung.conf`),\nenvironment variables, or command line arguments.\n\nCommand line arguments override environment variables which themselves override settings in\nthe configuration file.\n\n#### Configuration file\n\nThe configuration files will be evaluated in the following order (last takes precedence over first):\n\n 1. `/etc/suisa_sendemeldung.conf`\n 2. `$HOME/suisa_sendemeldung.conf`\n 3. `./suisa_sendemeldung.conf`\n\nFor details on how to set configuration values, have a look at [suisa_sendemeldung.conf](etc/suisa_sendemeldung.conf).\n\n#### Environment variables\n\nEnvironment variables can also be passed as options. The relevant variables are listed in the [Usage](#Usage) part of this document. For example run the script as follows:\n\n```bash\npodman run --rm -ti -e BEARER_TOKEN=abcdefghijklmnopqrstuvwxyzabcdef -e STREAM_ID=a-bcdefgh -e STDOUT=True ghcr.io/radiorabe/suisasendemeldung:latest suisa_sendemeldung\n```\n\n#### Command line switches\n\nAs documented in [Usage](#Usage), you can also pass in options on the command line as arguments. Simply run the script as follows:\n\n```bash\npodman run --rm -ti ghcr.io/radiorabe/suisasendemeldung:latest suisa_sendemeldung --bearer-token=abcdefghijklmnopqrstuvwxyzabcdef --stream_id=a-bcdefgh --stdout\n```\n\n## Development\n\nSnapshot testing is used to test the help output, you can update the snapshots like so:\n```\npoetry run pytest -- --snapshot-update\n```\n\n## Release Management\n\nAt 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.\n\nThe CI/CD setup uses semantic commit messages following the [conventional commits standard](https://www.conventionalcommits.org/en/v1.0.0/).\nThere is a GitHub Action in [.github/workflows/semantic-release.yaml](./.github/workflows/semantic-release.yaml)\nthat uses [go-semantic-commit](https://go-semantic-release.xyz/) to create new releases.\n\nThe commit message should be structured as follows:\n\n```\n<type>[optional scope]: <description>\n\n[optional body]\n\n[optional footer(s)]\n```\n\nThe commit contains the following structural elements, to communicate intent to the consumers of your library:\n\n1. **fix:** a commit of the type `fix` patches gets released with a PATCH version bump\n1. **feat:** a commit of the type `feat` gets released as a MINOR version bump\n1. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:` gets released as a MAJOR version bump\n1. types other than `fix:` and `feat:` are allowed and don't trigger a release\n\nIf a commit does not contain a conventional commit style message you can fix\nit during the squash and merge operation on the PR.\n\nOnce a commit has landed on the `main` branch a release will be created and automatically published to [pypi](https://pypi.org/)\nusing the GitHub Action in [.github/workflows/release.yaml](./.github/workflows/reliease.yaml) which uses [twine](https://twine.readthedocs.io/)\nto publish the package to pypi. The `release.yaml` action also takes care of pushing a [container](https://opencontainers.org/)\nimage to [GitHub Packages](https://github.com/features/packages).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "ACRCloud client for SUISA reporting",
"version": "0.16.0",
"project_urls": {
"Homepage": "http://github.com/radiorabe/suisa_reporting",
"Repository": "http://github.com/radiorabe/suisa_reporting"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94e52dbf41ade9c4eb71e7cc2aa325adde682fddfdf40a12f86b780efebb1026",
"md5": "63a89532d150bf3ab2987a4c6de5754d",
"sha256": "5fb7c7fd27c6f54ea5a6c49737c6624ea9f7c7e83f1ad855fb0fff3a5a77d8b8"
},
"downloads": -1,
"filename": "suisa_sendemeldung-0.16.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "63a89532d150bf3ab2987a4c6de5754d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 15030,
"upload_time": "2024-12-16T17:57:12",
"upload_time_iso_8601": "2024-12-16T17:57:12.669412Z",
"url": "https://files.pythonhosted.org/packages/94/e5/2dbf41ade9c4eb71e7cc2aa325adde682fddfdf40a12f86b780efebb1026/suisa_sendemeldung-0.16.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95da32875371860d4e9141ad656f28c1ec04b48a6b5ba77ca9ec93aa8252433f",
"md5": "aa301dde1c3013e584ff60be1ee5d134",
"sha256": "39db236b31c51c49d1930a9f066ca49d39e19e4dc5a3fa2106843881e8cdfb14"
},
"downloads": -1,
"filename": "suisa_sendemeldung-0.16.0.tar.gz",
"has_sig": false,
"md5_digest": "aa301dde1c3013e584ff60be1ee5d134",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 15322,
"upload_time": "2024-12-16T17:57:14",
"upload_time_iso_8601": "2024-12-16T17:57:14.413393Z",
"url": "https://files.pythonhosted.org/packages/95/da/32875371860d4e9141ad656f28c1ec04b48a6b5ba77ca9ec93aa8252433f/suisa_sendemeldung-0.16.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 17:57:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "radiorabe",
"github_project": "suisa_reporting",
"github_not_found": true,
"lcname": "suisa_sendemeldung"
}
JSON
