v1.0

.gitignore

@@ -0,0 +1,32 @@
+ # Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# Unit test / coverage reports (not currently used)
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+.pytest_cache
+nosetests.xml
+coverage.xml
+*,cover
+.coveralls.yml
+.mypy_cache
+
+# Sphinx documentation
+docs/build/
+
+# Pickle and log files
+abb*
+
+# Saved headers
+/headers/*.png
+
+# Pycharm
+.idea/
+
+# virtual environment
+venv/
+/env/

.gitlab-ci.yml

@@ -0,0 +1,29 @@
+stages:
+  - pages
+
+pages:
+  stage: pages
+
+  variables:
+    GIT_SUBMODULE_STRATEGY: recursive
+
+  rules:
+    - if: '$CI_COMMIT_BRANCH == "master" || $CI_COMMIT_BRANCH == "dev"'
+      changes:
+        - "**/*.rst"
+        - "**/*.py"
+
+  image: python:3.8-slim
+
+  script:
+  - apt-get update
+  - apt-get install -y git
+  - python -W ignore -m pip install --upgrade pip
+  - python -W ignore -m pip install -r docs/requirements-docs.txt
+  - python -W ignore -m pip install -r requirements.txt
+  - sphinx-build docs/source docs/build/html
+  - mv docs/build/html public
+
+  artifacts:
+    paths:
+    - public

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/source/_static"]
+	path = docs/source/_static
+	url = https://github.com/Bibo-Joshi/sphinx_rtd_theme

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+# Make sure that
+#   * the revs specified here match requirements-dev.txt
+#   * the makefile checks the same files as pre-commit
+#   * MyPy gets all dependencies as additional dependencies
+repos:
+- repo: https://github.com/psf/black
+  rev: 20.8b1
+  hooks:
+      - id: black
+        args:
+            - --diff
+            - --check
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.1
+    hooks:
+    -   id: flake8
+-   repo: https://github.com/PyCQA/pylint
+    rev: pylint-2.6.0
+    hooks:
+    -   id: pylint
+        language: python
+        language_version: python3.8
+        files: ^(main|bot/.*)\.py$
+        args:
+        - --rcfile=setup.cfg
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.790
+    hooks:
+    -   id: mypy
+        language: python
+        language_version: python3.8
+        additional_dependencies:
+            - python-telegram-bot>=13.3,<14.0
+            - git+https://github.com/python-telegram-bot/ptbcontrib.git@5eda3817f8a4ee196dfa37efd5775ed00c7b047c
+            - pytz
+            - rapidfuzz==1.1.1
+        files: ^(main|bot/.*)\.py$

CHANGES.rst

@@ -0,0 +1,9 @@
+=========
+Changelog
+=========
+
+Version 1.0
+===========
+*Released 2021-02-28*
+
+Initial version.

README.rst

@@ -1,4 +1,44 @@
 AkaBlas-Bot
 ===========
 
-Simple Telegram bot designed to help the board of AkaBlas.
+.. image:: https://img.shields.io/badge/read%20the-user%20guide-orange?logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjxzdmcKICAgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIgogICB4bWxuczpjYz0iaHR0cDovL2NyZWF0aXZlY29tbW9ucy5vcmcvbnMjIgogICB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiCiAgIHhtbG5zOnN2Zz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiAgIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIKICAgeG1sbnM6c29kaXBvZGk9Imh0dHA6Ly9zb2RpcG9kaS5zb3VyY2Vmb3JnZS5uZXQvRFREL3NvZGlwb2RpLTAuZHRkIgogICB4bWxuczppbmtzY2FwZT0iaHR0cDovL3d3dy5pbmtzY2FwZS5vcmcvbmFtZXNwYWNlcy9pbmtzY2FwZSIKICAgdmlld0JveD0iLTEgLTI1NiAxNjY1LjMyODIgMTUzNiIKICAgaWQ9InN2ZzMwMjUiCiAgIHZlcnNpb249IjEuMSIKICAgaW5rc2NhcGU6dmVyc2lvbj0iMC45Mi40ICg1ZGE2ODljMzEzLCAyMDE5LTAxLTE0KSIKICAgd2lkdGg9IjE2NjUuMzI4MiIKICAgaGVpZ2h0PSIxNTM2IgogICBzb2RpcG9kaTpkb2NuYW1lPSJCb29rX2ZvbnRfYXdlc29tZS5zdmciCiAgIGlua3NjYXBlOmV4cG9ydC1maWxlbmFtZT0iQzpcVXNlcnNcSGlucmljaFxEZXNrdG9wXEJvb2tfZm9udF9hd2Vzb21lLnBuZyIKICAgaW5rc2NhcGU6ZXhwb3J0LXhkcGk9IjUuNzYwMDAwMiIKICAgaW5rc2NhcGU6ZXhwb3J0LXlkcGk9IjUuNzYwMDAwMiI+CiAgPG1ldGFkYXRhCiAgICAgaWQ9Im1ldGFkYXRhMzAzNSI+CiAgICA8cmRmOlJERj4KICAgICAgPGNjOldvcmsKICAgICAgICAgcmRmOmFib3V0PSIiPgogICAgICAgIDxkYzpmb3JtYXQ+aW1hZ2Uvc3ZnK3htbDwvZGM6Zm9ybWF0PgogICAgICAgIDxkYzp0eXBlCiAgICAgICAgICAgcmRmOnJlc291cmNlPSJodHRwOi8vcHVybC5vcmcvZGMvZGNtaXR5cGUvU3RpbGxJbWFnZSIgLz4KICAgICAgPC9jYzpXb3JrPgogICAgPC9yZGY6UkRGPgogIDwvbWV0YWRhdGE+CiAgPGRlZnMKICAgICBpZD0iZGVmczMwMzMiIC8+CiAgPHNvZGlwb2RpOm5hbWVkdmlldwogICAgIHBhZ2Vjb2xvcj0iI2ZmZmZmZiIKICAgICBib3JkZXJjb2xvcj0iIzY2NjY2NiIKICAgICBib3JkZXJvcGFjaXR5PSIxIgogICAgIG9iamVjdHRvbGVyYW5jZT0iMTAiCiAgICAgZ3JpZHRvbGVyYW5jZT0iMTAiCiAgICAgZ3VpZGV0b2xlcmFuY2U9IjEwIgogICAgIGlua3NjYXBlOnBhZ2VvcGFjaXR5PSIwIgogICAgIGlua3NjYXBlOnBhZ2VzaGFkb3c9IjIiCiAgICAgaW5rc2NhcGU6d2luZG93LXdpZHRoPSIxODAwIgogICAgIGlua3NjYXBlOndpbmRvdy1oZWlnaHQ9IjEwNTkiCiAgICAgaWQ9Im5hbWVkdmlldzMwMzEiCiAgICAgc2hvd2dyaWQ9ImZhbHNlIgogICAgIGlua3NjYXBlOnpvb209IjAuMDkzMTIzNDM4IgogICAgIGlua3NjYXBlOmN4PSI5MDguNDE4NzIiCiAgICAgaW5rc2NhcGU6Y3k9IjcxNC4xMzg4NCIKICAgICBpbmtzY2FwZTp3aW5kb3cteD0iLTkiCiAgICAgaW5rc2NhcGU6d2luZG93LXk9Ii05IgogICAgIGlua3NjYXBlOndpbmRvdy1tYXhpbWl6ZWQ9IjEiCiAgICAgaW5rc2NhcGU6Y3VycmVudC1sYXllcj0ic3ZnMzAyNSIgLz4KICA8cGF0aAogICAgIHN0eWxlPSJmaWxsOmN1cnJlbnRDb2xvciIKICAgICBpbmtzY2FwZTpjb25uZWN0b3ItY3VydmF0dXJlPSIwIgogICAgIGlkPSJwYXRoMzAyOSIKICAgICBkPSJtIDE2MzguNTIxNyw5NCBxIDQwLDU3IDE4LDEyOSBsIC0yNzUsOTA2IHEgLTE5LDY0IC03Ni41LDEwNy41IC01Ny41LDQzLjUgLTEyMi41LDQzLjUgSCAyNTkuNTIxNzQgcSAtNzcsMCAtMTQ4LjUsLTUzLjUgUSAzOS41MjE3MzksMTE3MyAxMS41MjE3MzksMTA5NSBxIC0yNCwtNjcgLTEuOTk5OTk5OSwtMTI3IDAsLTQgMi45OTk5OTk5LC0yNyAzLC0yMyA0LC0zNyAxLC04IC0zLC0yMS41IC0zLjk5OTk5OTksLTEzLjUgLTMsLTE5LjUgMiwtMTEgOCwtMjEgNiwtMTAgMTYuNSwtMjMuNSAxMC41LC0xMy41IDE2LjUsLTIzLjUgMjMsLTM4IDQ1LC05MS41IDIyLjAwMDAwMSwtNTMuNSAzMC4wMDAwMDEsLTkxLjUgMywtMTAgMC41LC0zMCAtMi41LC0yMCAtMC41LC0yOCAzLC0xMSAxNywtMjggMTQsLTE3IDE3LC0yMyAyMSwtMzYgNDIsLTkyIDIxLC01NiAyNSwtOTAgMSwtOSAtMi41LC0zMiAtMy41LC0yMyAwLjUsLTI4IDQsLTEzIDIyLC0zMC41IDE4LC0xNy41IDIyLC0yMi41IDE5LC0yNiA0Mi41LC04NC41IDIzLjUsLTU4LjUgMjcuNSwtOTYuNSAxLC04IC0zLC0yNS41IC00LC0xNy41IC0yLC0yNi41IDIsLTggOSwtMTggNywtMTAgMTgsLTIzIDExLC0xMyAxNywtMjEgOCwtMTIgMTYuNSwtMzAuNSA4LjUsLTE4LjUgMTUsLTM1IDYuNSwtMTYuNSAxNiwtMzYgOS41LC0xOS41IDE5LjUsLTMyIDEwLC0xMi41IDI2LjUsLTIzLjUgMTYuNSwtMTEgMzYsLTExLjUgMTkuNSwtMC41IDQ3LjUsNS41IGwgLTEsMyBxIDM4LC05IDUxLC05IGggNzYwLjk5OTk2IHEgNzQsMCAxMTQsNTYgNDAsNTYgMTgsMTMwIGwgLTI3NCw5MDYgcSAtMzYsMTE5IC03MS41LDE1My41IC0zNS41LDM0LjUgLTEyOC41LDM0LjUgSCAxNTUuNTIxNzQgcSAtMjcsMCAtMzgsMTUgLTExLDE2IC0xLDQzIDI0LDcwIDE0NCw3MCBoIDkyMi45OTk5NiBxIDI5LDAgNTYsLTE1LjUgMjcsLTE1LjUgMzUsLTQxLjUgbCAzMDAsLTk4NyBxIDcsLTIyIDUsLTU3IDM4LDE1IDU5LDQzIHogTSA1NzQuNTIxNzQsOTYgcSAtNCwxMyAyLDIyLjUgNiw5LjUgMjAsOS41IGggNjA3Ljk5OTk2IHEgMTMsMCAyNS41LC05LjUgMTIuNSwtOS41IDE2LjUsLTIyLjUgbCAyMSwtNjQgcSA0LC0xMyAtMiwtMjIuNSAtNiwtOS41IC0yMCwtOS41IEggNjM3LjUyMTc0IHEgLTEzLDAgLTI1LjUsOS41IC0xMi41LDkuNSAtMTYuNSwyMi41IHogbSAtODMsMjU2IHEgLTQsMTMgMiwyMi41IDYsOS41IDIwLDkuNSBoIDYwNy45OTk5NiBxIDEzLDAgMjUuNSwtOS41IDEyLjUsLTkuNSAxNi41LC0yMi41IGwgMjEsLTY0IHEgNCwtMTMgLTIsLTIyLjUgLTYsLTkuNSAtMjAsLTkuNSBIIDU1NC41MjE3NCBxIC0xMywwIC0yNS41LDkuNSAtMTIuNSw5LjUgLTE2LjUsMjIuNSB6IiAvPgo8L3N2Zz4K
+   :target: https://hirschheissich.gitlab.io/akablas-bot/userguide
+   :alt: User Guide
+
+.. image:: https://img.shields.io/badge/python-3.8+-blue?logo=python&logoColor=white
+   :target: https://www.python.org/doc/versions/
+   :alt: Supported Python versions
+
+.. image:: https://img.shields.io/badge/backend-python--telegram--bot-blue
+   :target: https://python-telegram-bot.org/
+   :alt: Backend: python-telegram-bot
+
+.. image:: https://img.shields.io/badge/documentation-is%20here-orange?logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjxzdmcKICAgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIgogICB4bWxuczpjYz0iaHR0cDovL2NyZWF0aXZlY29tbW9ucy5vcmcvbnMjIgogICB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiCiAgIHhtbG5zOnN2Zz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiAgIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIKICAgeG1sbnM6c29kaXBvZGk9Imh0dHA6Ly9zb2RpcG9kaS5zb3VyY2Vmb3JnZS5uZXQvRFREL3NvZGlwb2RpLTAuZHRkIgogICB4bWxuczppbmtzY2FwZT0iaHR0cDovL3d3dy5pbmtzY2FwZS5vcmcvbmFtZXNwYWNlcy9pbmtzY2FwZSIKICAgdmlld0JveD0iLTEgLTI1NiAxNjY1LjMyODIgMTUzNiIKICAgaWQ9InN2ZzMwMjUiCiAgIHZlcnNpb249IjEuMSIKICAgaW5rc2NhcGU6dmVyc2lvbj0iMC45Mi40ICg1ZGE2ODljMzEzLCAyMDE5LTAxLTE0KSIKICAgd2lkdGg9IjE2NjUuMzI4MiIKICAgaGVpZ2h0PSIxNTM2IgogICBzb2RpcG9kaTpkb2NuYW1lPSJCb29rX2ZvbnRfYXdlc29tZS5zdmciCiAgIGlua3NjYXBlOmV4cG9ydC1maWxlbmFtZT0iQzpcVXNlcnNcSGlucmljaFxEZXNrdG9wXEJvb2tfZm9udF9hd2Vzb21lLnBuZyIKICAgaW5rc2NhcGU6ZXhwb3J0LXhkcGk9IjUuNzYwMDAwMiIKICAgaW5rc2NhcGU6ZXhwb3J0LXlkcGk9IjUuNzYwMDAwMiI+CiAgPG1ldGFkYXRhCiAgICAgaWQ9Im1ldGFkYXRhMzAzNSI+CiAgICA8cmRmOlJERj4KICAgICAgPGNjOldvcmsKICAgICAgICAgcmRmOmFib3V0PSIiPgogICAgICAgIDxkYzpmb3JtYXQ+aW1hZ2Uvc3ZnK3htbDwvZGM6Zm9ybWF0PgogICAgICAgIDxkYzp0eXBlCiAgICAgICAgICAgcmRmOnJlc291cmNlPSJodHRwOi8vcHVybC5vcmcvZGMvZGNtaXR5cGUvU3RpbGxJbWFnZSIgLz4KICAgICAgPC9jYzpXb3JrPgogICAgPC9yZGY6UkRGPgogIDwvbWV0YWRhdGE+CiAgPGRlZnMKICAgICBpZD0iZGVmczMwMzMiIC8+CiAgPHNvZGlwb2RpOm5hbWVkdmlldwogICAgIHBhZ2Vjb2xvcj0iI2ZmZmZmZiIKICAgICBib3JkZXJjb2xvcj0iIzY2NjY2NiIKICAgICBib3JkZXJvcGFjaXR5PSIxIgogICAgIG9iamVjdHRvbGVyYW5jZT0iMTAiCiAgICAgZ3JpZHRvbGVyYW5jZT0iMTAiCiAgICAgZ3VpZGV0b2xlcmFuY2U9IjEwIgogICAgIGlua3NjYXBlOnBhZ2VvcGFjaXR5PSIwIgogICAgIGlua3NjYXBlOnBhZ2VzaGFkb3c9IjIiCiAgICAgaW5rc2NhcGU6d2luZG93LXdpZHRoPSIxODAwIgogICAgIGlua3NjYXBlOndpbmRvdy1oZWlnaHQ9IjEwNTkiCiAgICAgaWQ9Im5hbWVkdmlldzMwMzEiCiAgICAgc2hvd2dyaWQ9ImZhbHNlIgogICAgIGlua3NjYXBlOnpvb209IjAuMDkzMTIzNDM4IgogICAgIGlua3NjYXBlOmN4PSI5MDguNDE4NzIiCiAgICAgaW5rc2NhcGU6Y3k9IjcxNC4xMzg4NCIKICAgICBpbmtzY2FwZTp3aW5kb3cteD0iLTkiCiAgICAgaW5rc2NhcGU6d2luZG93LXk9Ii05IgogICAgIGlua3NjYXBlOndpbmRvdy1tYXhpbWl6ZWQ9IjEiCiAgICAgaW5rc2NhcGU6Y3VycmVudC1sYXllcj0ic3ZnMzAyNSIgLz4KICA8cGF0aAogICAgIHN0eWxlPSJmaWxsOmN1cnJlbnRDb2xvciIKICAgICBpbmtzY2FwZTpjb25uZWN0b3ItY3VydmF0dXJlPSIwIgogICAgIGlkPSJwYXRoMzAyOSIKICAgICBkPSJtIDE2MzguNTIxNyw5NCBxIDQwLDU3IDE4LDEyOSBsIC0yNzUsOTA2IHEgLTE5LDY0IC03Ni41LDEwNy41IC01Ny41LDQzLjUgLTEyMi41LDQzLjUgSCAyNTkuNTIxNzQgcSAtNzcsMCAtMTQ4LjUsLTUzLjUgUSAzOS41MjE3MzksMTE3MyAxMS41MjE3MzksMTA5NSBxIC0yNCwtNjcgLTEuOTk5OTk5OSwtMTI3IDAsLTQgMi45OTk5OTk5LC0yNyAzLC0yMyA0LC0zNyAxLC04IC0zLC0yMS41IC0zLjk5OTk5OTksLTEzLjUgLTMsLTE5LjUgMiwtMTEgOCwtMjEgNiwtMTAgMTYuNSwtMjMuNSAxMC41LC0xMy41IDE2LjUsLTIzLjUgMjMsLTM4IDQ1LC05MS41IDIyLjAwMDAwMSwtNTMuNSAzMC4wMDAwMDEsLTkxLjUgMywtMTAgMC41LC0zMCAtMi41LC0yMCAtMC41LC0yOCAzLC0xMSAxNywtMjggMTQsLTE3IDE3LC0yMyAyMSwtMzYgNDIsLTkyIDIxLC01NiAyNSwtOTAgMSwtOSAtMi41LC0zMiAtMy41LC0yMyAwLjUsLTI4IDQsLTEzIDIyLC0zMC41IDE4LC0xNy41IDIyLC0yMi41IDE5LC0yNiA0Mi41LC04NC41IDIzLjUsLTU4LjUgMjcuNSwtOTYuNSAxLC04IC0zLC0yNS41IC00LC0xNy41IC0yLC0yNi41IDIsLTggOSwtMTggNywtMTAgMTgsLTIzIDExLC0xMyAxNywtMjEgOCwtMTIgMTYuNSwtMzAuNSA4LjUsLTE4LjUgMTUsLTM1IDYuNSwtMTYuNSAxNiwtMzYgOS41LC0xOS41IDE5LjUsLTMyIDEwLC0xMi41IDI2LjUsLTIzLjUgMTYuNSwtMTEgMzYsLTExLjUgMTkuNSwtMC41IDQ3LjUsNS41IGwgLTEsMyBxIDM4LC05IDUxLC05IGggNzYwLjk5OTk2IHEgNzQsMCAxMTQsNTYgNDAsNTYgMTgsMTMwIGwgLTI3NCw5MDYgcSAtMzYsMTE5IC03MS41LDE1My41IC0zNS41LDM0LjUgLTEyOC41LDM0LjUgSCAxNTUuNTIxNzQgcSAtMjcsMCAtMzgsMTUgLTExLDE2IC0xLDQzIDI0LDcwIDE0NCw3MCBoIDkyMi45OTk5NiBxIDI5LDAgNTYsLTE1LjUgMjcsLTE1LjUgMzUsLTQxLjUgbCAzMDAsLTk4NyBxIDcsLTIyIDUsLTU3IDM4LDE1IDU5LDQzIHogTSA1NzQuNTIxNzQsOTYgcSAtNCwxMyAyLDIyLjUgNiw5LjUgMjAsOS41IGggNjA3Ljk5OTk2IHEgMTMsMCAyNS41LC05LjUgMTIuNSwtOS41IDE2LjUsLTIyLjUgbCAyMSwtNjQgcSA0LC0xMyAtMiwtMjIuNSAtNiwtOS41IC0yMCwtOS41IEggNjM3LjUyMTc0IHEgLTEzLDAgLTI1LjUsOS41IC0xMi41LDkuNSAtMTYuNSwyMi41IHogbSAtODMsMjU2IHEgLTQsMTMgMiwyMi41IDYsOS41IDIwLDkuNSBoIDYwNy45OTk5NiBxIDEzLDAgMjUuNSwtOS41IDEyLjUsLTkuNSAxNi41LC0yMi41IGwgMjEsLTY0IHEgNCwtMTMgLTIsLTIyLjUgLTYsLTkuNSAtMjAsLTkuNSBIIDU1NC41MjE3NCBxIC0xMywwIC0yNS41LDkuNSAtMTIuNSw5LjUgLTE2LjUsMjIuNSB6IiAvPgo8L3N2Zz4K
+   :target: https://hirschheissich.gitlab.io/akablas-bot/
+   :alt: Documentation
+
+.. image:: https://img.shields.io/badge/chat%20on-Telegram-blue?logo=telegram
+   :target: https://t.me/AkaBlasBot
+   :alt: Telegram Chat
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/psf/black
+    :alt: Code Style Black
+
+German
+------
+
+Ein Telegram Bot, der dem Vorstand der »Akademische Bläservereinigung an der TU Braunschweig« helfen soll, den Überblick darüber zu behalten, welches Register gerade den Probenraum fegen muss.
+
+Auf Telegram ist er als `@AkaBlasBot <https://t.me/AkaBlasBot>`_ zu finden.
+
+Eine Kurzanleitung gibt es `hier <https://hirschheissich.gitlab.com/akablas-bot/userguide>`_.
+
+English
+-------
+
+A simple Telegram bot designed to help the board of  »Akademische Bläservereinigung an der TU Braunschweig« remember, which instrument groups turn it is to clean the rehersal room.
+
+Find it on Telegram as `@AkaBlasBot <https://t.me/AkaBlasBot>`_.
+
+A quickstart guide in german can be found `here <https://hirschheissich.gitlab.com/akablas-bot/userguide>`_.

bot.ini

@@ -0,0 +1,3 @@
+[yourls-bot]
+token = bot_token
+admins_chat_id = 123456789

bot/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-