chore: Add GitHub Actions workflows for code formatting, testing, and CodeQL analysis

.description

@@ -1,2 +1 @@
 <a href="https://no.wikipedia.org/wiki/User:UKBot">UKBot</a> is a bot for updating results in weekly contests held at Norwegian and Finnish Wikipedia (<a href="github.com/danmichaelo/UKBot">source</a>)
-

.env.dist

@@ -10,4 +10,4 @@ DB_PASSWORD=ukbot
 MW_CONSUMER_TOKEN=
 MW_CONSUMER_SECRET=
 MW_ACCESS_TOKEN=
-MW_ACCESS_SECRET=
+MW_ACCESS_SECRET=

.github/ISSUE_TEMPLATE/bug_report.md

@@ -24,4 +24,4 @@ Describe what happens when you follow the steps above.
 A clear and concise description of what you expected to happen.
 
 **Additional context**
-Add any other context about the problem here.
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -17,4 +17,4 @@ A clear and concise description of one or more use cases. Ex. As a ..., I want t
 A clear and concise description of any alternative solutions or features you've considered.
 
 **Additional context**
-Add any other context or screenshots about the feature request here.
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,8 +1,8 @@
 ## Description
 
-<!-- 
-Please do not leave this blank 
-This PR [adds/removes/fixes/replaces] the [feature/bug/etc]. 
+<!--
+Please do not leave this blank
+This PR [adds/removes/fixes/replaces] the [feature/bug/etc].
 -->
 
 ## What type of PR is this? (check all applicable)
@@ -21,7 +21,7 @@ This PR [adds/removes/fixes/replaces] the [feature/bug/etc].
 
 ## Related Tickets & Documents
 
-<!-- 
+<!--
 Please use this format link issue numbers: Fixes #123
 -->
 
@@ -39,6 +39,6 @@ Please use this format link issue numbers: Fixes #123
 
 ## [optional] Are there any pre- or post-deployment tasks we need to perform?
 
-<!-- 
+<!--
 Write about changing templates or modules on-wiki in order to accomodate changes in this PR
--->
+-->

.github/workflows/check-format-and-typing.yml

@@ -0,0 +1,32 @@
+name: Code formatting and typing
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  CodeFormattingAndTyping:
+    name: Code formatting and typing
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v3
+
+      - name: Install Python 3
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements_dev.txt
+
+      - name: check format using pycodestyle (ignore error on line length>79)
+        id: formatChecks
+        run: flake8 ukbot
+
+      - name: mypy static type checker
+        run: mypy ukbot

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,27 @@
+name: "CodeQL"
+
+on:
+  schedule:
+    - cron: "40 2 * * 1"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["python"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.github/workflows/run-tests.yml

@@ -0,0 +1,31 @@
+name: Run Tests
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  run_tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v3
+
+      - name: Install Python 3
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements_dev.txt
+          pip install -e .
+
+      - name: Run tests with pytest
+        run: coverage run -m pytest test
+
+      - name: Print coverage report
+        run: coverage report -m

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: check-docstring-first
+    -   id: check-added-large-files
+    -   id: check-case-conflict
+    -   id: debug-statements
+    -   id: requirements-txt-fixer
+-   repo: https://github.com/pre-commit/mirrors-autopep8
+    rev: v1.6.0
+    hooks:
+    -   id: autopep8
+        additional_dependencies: ['pycodestyle==2.10.0']
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.6.0
+    hooks:
+    -   id: mypy
+        name: mypy ukbot
+        exclude: config/, locale/
+        entry: mypy ukbot/
+        pass_filenames: false
+        args: [--config-file=mypy.ini]
+        additional_dependencies:
+          - types-PyMySQL
+          - types-pytz
+          - types-PyYAML
+          - types-requests
+          - urllib3
+
+-   repo: https://github.com/PyCQA/flake8
+    rev: 4.0.1
+    hooks:
+    -   id: flake8

.travis.yml

@@ -5,8 +5,8 @@ python:
   - 3.5
   - 3.6
 
-# command to install dependencies, e.g. 
-install: 
+# command to install dependencies, e.g.
+install:
   - pip install -r requirements.txt
 
 script:

CODE_OF_CONDUCT.md

@@ -124,4 +124,4 @@ enforcement ladder](https://github.com/mozilla/diversity).
 
 For answers to common questions about this code of conduct, see the FAQ at
 https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -21,4 +21,4 @@ We welcome all feature requests, whether to add new functionality to `UKBot` or
 
 ### ⚙️ Close a Bug / Feature issue
 
-We welcome contributions that help make `UKBot` bug free & improve the experience of our users. You can also find issues tagged `bug` or `enhancement`. Check out our [Code Contribution Guide](docs/Code_Contributions_Guidelines.md) to begin.
+We welcome contributions that help make `UKBot` bug free & improve the experience of our users. You can also find issues tagged `bug` or `enhancement`. Check out our [Code Contribution Guide](docs/Code_Contributions_Guidelines.md) to begin.

ISSUES.md

@@ -14,4 +14,4 @@ The `bug report` and `feature request` issue templates are ready for you!
 2. The `UKBot` member provides feedback as soon as possible.
 3. A conversation or discussion between `UKBot` and the user.
 4. A pull request related to the issue will close it.
-5. Otherwise, we'll close the issue after seven days of no update.
+5. Otherwise, we'll close the issue after seven days of no update.

MANIFEST.in

@@ -1 +1 @@
-include locale/*/*/*.mo
+include locale/*/*/*.mo

MIT-LICENSE.txt

@@ -18,4 +18,3 @@ 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.
-

README.md

@@ -5,7 +5,7 @@
 <div align="center">
   <p>Created by <a href="https://github.com/danmichaelo">Dan Michael</a> and maintained with ❤︎ by <a href="https://github.com/WikimediaNorge/UKBot/graphs/contributors">contributors</a></p>
 </div>
- 
+
 ## Getting Started
 
 Clone code from github
@@ -66,13 +66,12 @@ To modify the code and test it locally, you'll need to install it as a pip packa
 
 ## Deployment
 
-The bot is deployed at [ToolForge](https://wikitech.wikimedia.org/wiki/Portal:Toolforge) under the "UKBot" account using 
-[Webservice](https://wikitech.wikimedia.org/wiki/Help:Toolforge/Web) and the [Toolforge Jobs Framework](https://wikitech.wikimedia.org/wiki/Portal:Toolforge/Admin/Kubernetes/Jobs_framework). 
+The bot is deployed at [ToolForge](https://wikitech.wikimedia.org/wiki/Portal:Toolforge) under the "UKBot" account using
+[Webservice](https://wikitech.wikimedia.org/wiki/Help:Toolforge/Web) and the [Toolforge Jobs Framework](https://wikitech.wikimedia.org/wiki/Portal:Toolforge/Admin/Kubernetes/Jobs_framework).
 
 See https://wikitech.wikimedia.org/wiki/Tool:UKBot for deployment notes.
 
 ## Other notes
 
 Forenklet flytkart:
 ![Flowchart](https://github.com/danmichaelo/UKBot/raw/master/flowchart.png)
-

config/config.en.yml

@@ -1,2 +1 @@
 _extends: sites/enwiki.yml
-

config/config.es-estonia.yml

@@ -18,4 +18,4 @@ plot:
         == {{int:license-header}} ==
         {{PD-self}}
 
-        [[Category:Wikipedia competitions]]
+        [[Category:Wikipedia competitions]]

config/config.fi-100.yml

@@ -47,8 +47,8 @@ plot:
         |Date           = %(start)s
         |Author         = [[User:UKBot|UKBot]]
         }}
-        
+
         == {{int:license-header}} ==
         {{PD-self}}
-        
+
         [[Category:Viikon kilpailu]]

config/config.fi-ek.yml

@@ -22,8 +22,8 @@ plot:
         |Date           = %(start)s
         |Author         = [[User:UKBot|UKBot]]
         }}
-        
+
         == {{int:license-header}} ==
         {{PD-self}}
-        
+
         [[Category:Elokuun kuvitustalkoot]]

config/config.fi-hl.yml

@@ -20,8 +20,8 @@ plot:
         |Date           = %(start)s
         |Author         = [[User:UKBot|UKBot]]
         }}
-        
+
         == {{int:license-header}} ==
         {{PD-self}}
-        
+
         [[Category:Heinäkuun lähdetalkoot]]

config/config.fi-pln.yml

@@ -23,8 +23,8 @@ plot:
         |Date           = %(start)s
         |Author         = [[User:UKBot|UKBot]]
         }}
-        
+
         == {{int:license-header}} ==
         {{PD-self}}
-        
+
         [[Category:Wikipedia contests of Finnish Wikipedia]]

config/config.fi-vk.yml

@@ -23,10 +23,10 @@ plot:
         |Date           = %(start)s
         |Author         = [[User:UKBot|UKBot]]
         }}
-        
+
         == {{int:license-header}} ==
         {{PD-self}}
-        
+
         [[Category:Viikon kilpailu %(year)s]]
 awards:
     sininen: { file: Article blue.svg, winner: true }

config/config.gl-estonia.yml

@@ -18,4 +18,4 @@ plot:
         == {{int:license-header}} ==
         {{PD-self}}
 
-        [[Category:Wikipedia competitions]]
+        [[Category:Wikipedia competitions]]

config/config.no-fd.yml

@@ -28,10 +28,10 @@ plot:
         |Date           = %(start)s
         |Author         = [[User:UKBot|UKBot]]
         }}
-        
+
         == {{int:license-header}} ==
         {{PD-self}}
-        
+
         [[Category:Fiks det!]]
 awards:
     blå: { file: FD-premie blå.svg, winner: true }

config/config.no-mk.yml

@@ -40,8 +40,8 @@ plot:
         |Date           = %(start)s
         |Author         = [[User:UKBot|UKBot]]
         }}
-        
+
         == {{int:license-header}} ==
         {{PD-self}}
-        
+
         [[Category:Månedens konkurranse %(year)s]]

config/config.no-uk.yml

@@ -30,8 +30,8 @@ plot:
         |Date           = %(start)s
         |Author         = [[User:UKBot|UKBot]]
         }}
-        
+
         == {{int:license-header}} ==
         {{PD-self}}
-        
+
         [[Category:Ukens konkurranse %(year)s]]

config/config.se.yml

@@ -15,10 +15,10 @@ plot:
         |Date           = %(start)s
         |Author         = [[User:UKBot|UKBot]]
         }}
-        
+
         == {{int:license-header}} ==
         {{PD-self}}
-        
+
         [[Category:Wikipedia contests]]
 awards:
     sininen: { file: Article blue.svg, winner: true }

docker-compose.yml

@@ -38,4 +38,4 @@ services:
   #     - ./:/src
 volumes:
   db:
-    driver: local
+    driver: local

docs/Code_Contributions_Guidelines.md

@@ -15,4 +15,15 @@ We use [GitHub Flow](https://guides.github.com/introduction/flow/index.html), so
 6. When you raise a pull request, we automatically run tests on our CI. Please ensure that all the tests are passing for your code change. We will not be able to accept your change if the test suite doesn't pass.
 
 ## 🏡 Setup for local development
-- In progress
+Install packages needed for development
+```bash
+pip install -r requirements.txt  -r requirements_dev.txt
+```
+Install [pre-commit](https://pre-commit.com/)
+```bash
+pre-commit install
+```
+When you have done your changes pre-commit will run when running `git commit`. To run it whenever you want type:
+```bash
+pre-commit run --all-files
+```