[GH-395] Port to Python 3

.gitattributes

@@ -1,2 +1,8 @@
 *.com linguist-vendored
 *.org linguist-vendored
+
+*.py text=auto
+*.sh text=auto
+*.json text=auto
+*.txt text=auto
+*.md text=auto

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,85 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!-- Thank you for helping to improve MediaWiki Dump Generator! -->
+
+<!-- So that we can better address your issue,
+please fill out as much of the following as possible. -->
+
+## Describe the Bug
+
+<!-- A brief but clear summary -->
+
+### Expected Behavior
+
+<!-- What did you expect to happen? -->
+
+### Actual Behavior
+
+<!-- What happened instead? -->
+
+## Command for Reproducing the Bug
+
+<!-- The command string you used, with full URL
+(Please copy and paste within the code block below.) -->
+
+```bash
+
+```
+
+## Output
+
+<details>
+<summary><code>stdout</code></summary>
+
+<!-- stdout (the text from the terminal window)
+(Please copy and paste within the code block below.) -->
+
+```bash
+
+```
+
+</details>
+
+<details>
+<summary><code>errors.log</code></summary>
+
+<!-- The errors.log file from the dump folder, if there is one
+(Please copy and paste within the code block below.) -->
+
+```text
+
+```
+
+</details>
+
+## Platform Details
+
+<!-- Please complete as much of the following as you're
+able to and remove whichever section is inapplicable -->
+
+### Desktop
+
+- OS and version: <!-- e.g. Kubuntu 23.04, Windows 10, macOS 14.2 -->
+- File system: <!-- e.g. EXT4, NTFS, APFS -->
+- Python version: <!-- `$ python --version` -->
+- Command line shell: <!-- `$ $SHELL --version` -->
+- `dumpgenerator` version: <!-- `$ dumpgenerator -v` -->
+
+### Smartphone or Tablet
+
+- OS: <!-- e.g. iOS 16.1, Android 11 -->
+- Python version: <!-- `$ python --version` -->
+- Command line shell: <!-- `$ $SHELL --version` -->
+- Terminal application used: <!-- e.g. Termux, Termius -->
+- `dumpgenerator` version: <!-- `$ dumpgenerator -v` -->
+
+## Additional Context
+
+<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Get help using MediaWiki Dump Generator
+    url: https://github.com/orgs/mediawiki-client-tools/discussions/categories/q-a
+    about: If you need help (other than reporting a bug), you can reach out on our Discussions Q&A.
+  - name: Anything else
+    url: https://github.com/orgs/mediawiki-client-tools/discussions
+    about: You can read and post in our GitHub Discussions.

.github/workflows/test-dumpgenerator.yml

@@ -0,0 +1,43 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: dumpgenerator test
+
+on:
+  push:
+    branches: [ "python3" ]
+  pull_request:
+    branches: [ "python3" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 pytest poetry
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # exit if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: run dumpgenerator
+      run: |
+        python -m wikiteam3.dumpgenerator -h
+    - name: Test with pytest
+      run: |
+        cd wikiteam3/dumpgenerator && pytest && cd ../../

.gitignore

@@ -1,9 +1,15 @@
 *.pyc
-testing/*.pyc
-testing/dumpgenerator.py
-/.tox
+.pytest_cache
 keys.txt
 batchdownload/keys.txt
 batchdownload/dumpgenerator.py
 batchdownload/uploader.py
+__pycache__
+tests/tmp
+dist/
+.DS_Store
+desktop.ini
 
+.venv
+.vscode
+.idea

.markdownlint.jsonc

@@ -0,0 +1,16 @@
+// If you change any options here,
+// please change them in .pymarkdown.jsonc
+// as well!
+{
+    "line-length": false,
+    "no-inline-html": {
+        "allowed_elements": [
+            "details",
+            "summary",
+            "code"
+        ]
+    },
+    "first-line-heading": {
+        "front_matter_title" : "name"
+    }
+}

.pre-commit-config.yaml

@@ -0,0 +1,65 @@
+# Apply to all files without commiting:
+#   pre-commit run --all-files
+# Update this file:
+#   pre-commit autoupdate
+default_language_version:
+    python: python3.8
+repos:
+-   repo: https://github.com/python-poetry/poetry
+    rev: 1.6.0
+    hooks:
+    -   id: poetry-check
+    # -   id: poetry-lock
+    -   id: poetry-export
+        args: ["-f", "requirements.txt", "-o", "requirements.txt"]
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: check-ast
+    -   id: fix-byte-order-marker
+    -   id: check-case-conflict
+    -   id: check-docstring-first
+    -   id: check-executables-have-shebangs
+    -   id: check-json
+    -   id: check-yaml
+    -   id: debug-statements
+    # -   id: detect-aws-credentials
+    # -   id: detect-private-key
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: mixed-line-ending
+# -   repo: https://github.com/pre-commit/mirrors-mypy
+#     rev: v0.942
+#     hooks:
+#     -   id: mypy
+#         args: [--ignore-missing-imports]
+-   repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+    -   id: isort
+        args: ["--profile", "black", "--filter-files"]
+-   repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.10.1
+    hooks:
+    -   id: pyupgrade
+        args: [--py38-plus]
+-   repo: https://github.com/asottile/blacken-docs
+    rev: 1.16.0
+    hooks:
+    -   id: blacken-docs
+        # additional_dependencies: [black==20.8b1]
+### Needs argument for diasabling line_length
+### https://github.com/jackdewinter/pymarkdown/blob/main/docs/rules/rule_md013.md
+-   repo: https://github.com/jackdewinter/pymarkdown
+    rev: v0.9.12
+    hooks:
+    -   id: pymarkdown
+        args:
+        -   --config=.pymarkdown.json
+        # -   --disable-rules
+        # -   line-length,no-inline-html
+        -   scan

.pymarkdown.json

@@ -0,0 +1,14 @@
+{
+    "plugins": {
+        "line-length": {
+            "enabled": false
+        },
+        "no-inline-html": {
+            "allowed_elements": "details,summary,code,!--"
+        },
+        "first-line-heading": {
+            "enabled": false,
+            "front_matter_title" : "name"
+        }
+    }
+}

.travis.yml

@@ -1,8 +1,9 @@
 language: python
-python: 2.7
+python: 3.8
 install:
-  - pip install tox 
+  - pip install poetry
+  - poetry install
 script:
-  - tox
+  - poetry run pytest --verbose -s
 notifications:
   email: false