https://github.com/cybcon/docker.dsb2pushover
A python based docker container that uses the DSBMobile data and sends the updates via pushover.
https://github.com/cybcon/docker.dsb2pushover
docker-image dsbmobile pushover-api python3
Last synced: 3 months ago
JSON representation
A python based docker container that uses the DSBMobile data and sends the updates via pushover.
- Host: GitHub
- URL: https://github.com/cybcon/docker.dsb2pushover
- Owner: cybcon
- License: mit
- Created: 2023-08-01T10:11:29.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-22T17:28:55.000Z (6 months ago)
- Last Synced: 2024-12-22T17:30:46.331Z (6 months ago)
- Topics: docker-image, dsbmobile, pushover-api, python3
- Language: Python
- Homepage: https://www.oberdorf-itc.de/
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Quick reference
Maintained by: [Michael Oberdorf IT-Consulting](https://www.oberdorf-itc.de/)
Source code: [GitHub](https://github.com/cybcon/docker.dsb2pushover)
Container image: [DockerHub](https://hub.docker.com/r/oitc/dsb2pushover)
[![][github-action-test-shield]][github-action-test-link]
[![][github-action-release-shield]][github-action-release-link]
[![][github-release-shield]][github-release-link]
[![][github-releasedate-shield]][github-releasedate-link]
[![][github-stars-shield]][github-stars-link]
[![][github-forks-shield]][github-forks-link]
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]
[![][docker-release-shield]][docker-release-link]
[![][docker-pulls-shield]][docker-pulls-link]
[![][docker-stars-shield]][docker-stars-link]
[![][docker-size-shield]][docker-size-link]
# Supported tags and respective `Dockerfile` links
* [`latest`, `1.0.14`](https://github.com/cybcon/docker.dsb2pushover/blob/v1.0.14/Dockerfile)
* [`1.0.13`](https://github.com/cybcon/docker.dsb2pushover/blob/v1.0.13/Dockerfile)
* [`1.0.12`](https://github.com/cybcon/docker.dsb2pushover/blob/v1.0.12/Dockerfile)
* [`1.0.9`](https://github.com/cybcon/docker.dsb2pushover/blob/v1.0.9/Dockerfile)
# What is the dsb2pushover container?
[DSBMobile](https://dsbmobile.de/) is a very common service in Germany for schools to manage substitution plans. There are several apps for the common mobile phone platforms.
After some problems with the DSBmobile app for Android I started looking for an API for DSBMobile to make the query more comfortable.
Here I came across the Python library [DSBApi](https://github.com/nerrixDE/DSBApi) and got inspired by it and built a Docker container from it, which filters out only the necessary entries for the coming day, prepares them and distributes them with the [Pushover](https://pushover.net/) service.
# Prerequisites to run the docker container
1. You need a DSBMobile login from the school (user and password)
2. You need a Pushover account and you need to create a new application for that (UserKey, ApiKey)
# Configuration
The docker container grab the configuration via environment variables.
| Environment variable name | Description | Required | Default value |
|--|--|--|--|
| `DSB_USERNAME` | The login username for DSBMobile | **MANDATORY** | |
| `DSB_PASSWORD` | The login password for DSBMobile | **MANDATORY** | |
| `PUSHOVER_USER_KEY` | The user key of your pushover account | **MANDATORY** | |
| `PUSHOVER_API_KEY` | The application key of your pushover application | **MANDATORY** | |
| `FILTER_SCHOOLCLASS` | The name of the school class in DSBMobile (regexp) | **OPTIONAL** | |
| `LOGLEVEL` | The loglevel of the application inside the container, can be one of: `debug`, `info`, `warning`, `error` | **OPTIONAL** | ` info` |
| `DSB_TABLE_FIELDS` | The table format of the DSBMobile tables, a comma separated list of attribute names | **OPTIONAL** | `type,class,lesson,subject,room,new_subject,new_teacher,teacher`
# Docker run
```
docker run --rm \
-e DSB_USERNAME='dsb_username' \
-e DSB_PASSWORD='mySecretPassword' \
-e PUSHOVER_USER_KEY='PushoverUserKey' \
-e PUSHOVER_API_KEY='PushoverApiKey' \
-e FILTER_SCHOOLCLASS='6a?b?cd?' \
-e DSB_TABLE_FIELDS='class,lesson,new_subject,room,subject,new_teacher,type,text' \
oitc/dsb2pushover:latest
```
# Docker compose configuration
```yaml
dsb2pushover:
restart: "no"
image: oitc/dsb2pushover:latest
environment:
DSB_USERNAME: 'dsb_username'
DSB_PASSWORD: 'mySecretPassword'
PUSHOVER_USER_KEY: 'PushoverUserKey'
PUSHOVER_API_KEY: 'PushoverApiKey'
FILTER_SCHOOLCLASS: '6a?b?cd?'
DSB_TABLE_FIELDS: 'class,lesson,new_subject,room,subject,new_teacher,type,text'
```
# Example crontab entry
This is an example crontab entry to trigger the docker container every 5pm to send the updates for tomorrow using docker compose.
```
0 17 * * * /usr/bin/docker-compose -f docker-compose.yml run --rm dsb2pushover >/dev/null 2>&1
```
# Donate
I would appreciate a small donation to support the further development of my open source projects.
# License
Copyright (c) 2023 Michael Oberdorf IT-Consulting
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[docker-pulls-link]: https://hub.docker.com/r/oitc/dsb2pushover
[docker-pulls-shield]: https://img.shields.io/docker/pulls/oitc/dsb2pushover?color=45cc11&labelColor=black&style=flat-square
[docker-release-link]: https://hub.docker.com/r/oitc/dsb2pushover
[docker-release-shield]: https://img.shields.io/docker/v/oitc/dsb2pushover?color=369eff&label=docker&labelColor=black&logo=docker&logoColor=white&style=flat-square
[docker-size-link]: https://hub.docker.com/r/oitc/dsb2pushover
[docker-size-shield]: https://img.shields.io/docker/image-size/oitc/dsb2pushover?color=369eff&labelColor=black&style=flat-square
[docker-stars-link]: https://hub.docker.com/r/oitc/dsb2pushover
[docker-stars-shield]: https://img.shields.io/docker/stars/oitc/dsb2pushover?color=45cc11&labelColor=black&style=flat-square
[github-action-release-link]: https://github.com/cybcon/docker.dsb2pushover/actions/workflows/release-from-label.yaml
[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/cybcon/docker.dsb2pushover/release-from-label.yaml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-action-test-link]: https://github.com/cybcon/docker.dsb2pushover/actions/workflows/test.yaml
[github-action-test-shield-original]: https://github.com/cybcon/docker.dsb2pushover/actions/workflows/test.yaml/badge.svg
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/cybcon/docker.dsb2pushover/test.yaml?label=tests&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-forks-link]: https://github.com/cybcon/docker.dsb2pushover/network/members
[github-forks-shield]: https://img.shields.io/github/forks/cybcon/docker.dsb2pushover?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/cybcon/docker.dsb2pushover/issues
[github-issues-shield]: https://img.shields.io/github/issues/cybcon/docker.dsb2pushover?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/cybcon/docker.dsb2pushover/blob/main/LICENSE
[github-license-shield]: https://img.shields.io/badge/license-MIT-blue?labelColor=black&style=flat-square
[github-release-link]: https://github.com/cybcon/docker.dsb2pushover/releases
[github-release-shield]: https://img.shields.io/github/v/release/cybcon/docker.dsb2pushover?color=369eff&labelColor=black&logo=github&style=flat-square
[github-releasedate-link]: https://github.com/cybcon/docker.dsb2pushover/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/cybcon/docker.dsb2pushover?labelColor=black&style=flat-square
[github-stars-link]: https://github.com/cybcon/docker.dsb2pushover
[github-stars-shield]: https://img.shields.io/github/stars/cybcon/docker.dsb2pushover?color=ffcb47&labelColor=black&style=flat-square