Merge 2021 additions (#5)

2021 updates to default branch

.github/workflows/ci.yaml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - master
+      - dev
+  push:
+    branches:
+      - master
+      - dev
+
+jobs:
+  linting:
+    name: Linting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.9'
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-${{ env.pythonLocation }}-pip-${{ hashFiles('**/vaalilakanabot2021.py') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.pythonLocation }}-pip-
+      - name: Install dependencies
+        run: pip install -r requirements.txt && pip install pylint
+      - name: Run pylint
+        run: pylint vaalilakanabot2021.py

.github/workflows/release.yaml

@@ -0,0 +1,45 @@
+name: Publish Docker image
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+    tags:
+      - v*
+  pull_request:
+    branches:
+      - master
+      - dev
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push:
+    name: Build and push image
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v2
+      - name: Log in to the Container registry
+        uses: docker/login-action@v1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -0,0 +1,9 @@
+*.env
+
+# Exclude all but example logs
+logs/*
+!example*
+
+#Exclude all but example data
+data/*
+!example*

.pylintrc

@@ -0,0 +1,33 @@
+[BASIC]
+argument-rgx=[a-z_][a-z0-9_]{0,30}
+attr-rgx=[a-z_][a-z0-9_]{0,30}
+const-rgx=[a-zA-Z_][a-zA-Z0-9_]{0,30}
+variable-rgx=[a-zA-Z_][a-zA-Z0-9_]{0,30}
+
+[FORMAT]
+max-line-length=120
+
+[MESSAGES CONTROL]
+disable=
+    arguments-differ,
+    broad-except,
+    consider-using-f-string,
+    fixme,
+    global-statement,
+    missing-class-docstring,
+    missing-final-newline,
+    missing-function-docstring,
+    missing-module-docstring,
+    no-else-return,
+    too-few-public-methods,
+    too-many-arguments,
+    too-many-boolean-expressions,
+    too-many-branches,
+    too-many-format-args,
+    too-many-instance-attributes,
+    too-many-locals,
+    too-many-nested-blocks,
+    too-many-return-statements,
+    too-many-statements,
+    unspecified-encoding,
+    unused-argument,

Dockerfile

@@ -0,0 +1,14 @@
+FROM python:3.9-slim
+
+LABEL version="2021" \
+    description="Vaalilakanabot" \
+    org.opencontainers.image.source="https://github.com/fyysikkokilta/vaalilakanabot"
+
+WORKDIR /bot
+COPY requirements.txt requirements.txt
+RUN pip install -r requirements.txt
+
+COPY assets ./assets
+COPY vaalilakanabot2021.py vaalilakanabot2021.py
+
+CMD ["python3", "vaalilakanabot2021.py"]

README.md

@@ -15,6 +15,18 @@ Telegram-botti, joka vaalien aikaan ylläpitää listausta ehdolle asettuneista
 - `$ python vaalilakanabot2019.py` 
 - lisää botti relevantteihin keskusteluryhmiin
 
+## Running the bot with Docker
+- create copies of the example_*.json files with such names that the "example_" part is removed.
+- create `bot.env` where `VAALILAKANABOT_TOKEN` and `ADMIN_CHAT_ID` env variables are stored
+- Update TOPIC_LIST_URL ja QUESTION_LIST_URL -variables in the code. See [Discourse documentation](https://docs.discourse.org/#tag/Categories/paths/~1c~1{id}.json/get) for formatting.
+- ```bash
+  # Use this to run the development container (from dev branch in GitHub) 
+  docker-compose -f docker-compose.yml --profile dev up -d
+
+  # Use this to run the production container (from master branch in GitHub) 
+  docker-compose -f docker-compose.yml --profile prod up -d
+    ```
+
 ## Komennot
 Botti tukee seuraavia komentoja:
 - `/start` Rekisteröi ryhmän botin tiedotuskanavaksi ja ryhmää saa botilta ilmoituksia.

vaalilakana.json → data/example_vaalilakana.json

@@ -1 +1 @@
-{"Puheenjohtaja": [{"name": "Patrik Lahti", "position": "Puheenjohtaja", "fiirumi": "https://fiirumi.fyysikkokilta.fi/t/patrik-lahti-puheenjohtajaksi-2020-for-president-2020/59", "valittu": true}], "Varapuheenjohtaja": [], "Rahastonhoitaja": [], "Fuksikapteeni": [], "IE": [], "Hupimestari": [], "Viestint\u00e4vastaava": [], "Kv-vastaava": [], "Yrityssuhdevastaava": [], "Opintovastaava": []}
+{"Puheenjohtaja": [{"name": "Patrik Lahti", "position": "Puheenjohtaja", "fiirumi": "https://fiirumi.fyysikkokilta.fi/t/patrik-lahti-puheenjohtajaksi-2020-for-president-2020/59", "valittu": true}], "Varapuheenjohtaja": [], "Rahastonhoitaja": [], "Fuksikapteeni": [], "IE": [], "Hupimestari": [], "Viestint\u00e4vastaava": [], "Kv-vastaava": [], "Yrityssuhdevastaava": [], "Opintovastaava": [], "ISOvastaava": [], "Jatkuvuustoimikunnan puheenjohtaja": [], "Excumestari": [], "Lukkarimestari": [], "Kvantin p\u00e4\u00e4toimittaja": []}

docker-compose.yml

@@ -0,0 +1,23 @@
+version: '3.4'
+services:
+  bot:
+    build: .
+    image: ghcr.io/fyysikkokilta/vaalilakanabot:master
+    volumes:
+      - ./data:/bot/data:rw
+      - ./logs:/bot/logs:rw
+    env_file:
+      - bot.env
+    profiles:
+      - prod
+
+  dev-bot:
+    build: .
+    image: ghcr.io/fyysikkokilta/vaalilakanabot:dev
+    volumes:
+      - ./data:/bot/data:rw
+      - ./logs:/bot/logs:rw
+    env_file:
+      - bot.env
+    profiles:
+      - dev

logs/example.log

@@ -0,0 +1 @@
+2021-10-02 16:16:58,056 - vaalilakanabot - INFO - Loaded channels:

requirements.txt

@@ -0,0 +1,3 @@
+python-telegram-bot
+requests
+lxml