set up basic repo structure

.github/workflows/backend-QA.yaml

@@ -0,0 +1,38 @@
+name: Backend QA
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  check-qa:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version-file: backend/pyproject.toml
+          architecture: x64
+
+      - name: Install dependencies (and project)
+        working-directory: backend
+        run: |
+          pip install -U pip
+          pip install -e .[lint,scripts,test,check]
+
+      - name: Check black formatting
+        working-directory: backend
+        run: inv lint-black
+
+      - name: Check ruff
+        working-directory: backend
+        run: inv lint-ruff
+
+      - name: Check pyright
+        working-directory: backend
+        run: inv check-pyright

.github/workflows/worker-QA.yaml

@@ -0,0 +1,38 @@
+name: Worker QA
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  check-qa:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version-file: worker/pyproject.toml
+          architecture: x64
+
+      - name: Install dependencies (and project)
+        working-directory: worker
+        run: |
+          pip install -U pip
+          pip install -e .[lint,scripts,test,check]
+
+      - name: Check black formatting
+        working-directory: worker
+        run: inv lint-black
+
+      - name: Check ruff
+        working-directory: worker
+        run: inv lint-ruff
+
+      - name: Check pyright
+        working-directory: worker
+        run: inv check-pyright

.gitignore

@@ -1,3 +1,6 @@
+# Editors
+*.vim
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+  -   id: trailing-whitespace
+  -   id: end-of-file-fixer
+- repo: https://github.com/psf/black
+  rev: "24.1.1"
+  hooks:
+  -   id: black
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.2.0
+  hooks:
+  - id: ruff
+- repo: https://github.com/RobertCraigie/pyright-python
+  rev: v1.1.349
+  hooks:
+  - id: pyright
+    name: pyright (system)
+    description: 'pyright static type checker'
+    entry: pyright
+    language: system
+    'types_or': [python, pyi]
+    require_serial: true
+    minimum_pre_commit_version: '2.9.2'

CHANGELOG.md

@@ -0,0 +1,123 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.1] - 2024-04-19
+
+### Fixed
+
+- Fix ruff command to use the now mandatory `check` command for fixing
+
+### Added
+
+## [1.0.0] - 2024-02-13
+
+### Added
+
+- Add versioning to the convention
+- Mention the adherence to Python convention in README.md
+
+### Changed
+
+- Move wiki doc to repo for proper review / versioning
+- Disable pyright bytes type promotions
+
+## [0.2.0] - 2024-02-05
+
+### Changed
+
+- Adopt hatch-openzim for metadata computation
+- Upgrade dependencies
+- Upgrade to Python 3.11 + 3.12 (instead of 3.10 + 3.11)
+- Fix ruff configuration in pyproject.toml to fix depreciation warning in 0.2
+- Fix Pyright ignore rules to adapt to breaking changes in 1.1.348
+
+## [0.1.10] - 2023-12-12
+
+### Fixed
+
+- Add package location to adapt to hatchling 1.19.0
+
+## [0.1.9] - 2023-09-19
+
+### Changed
+
+- Split Docker build for efficiency
+
+## [0.1.8] - 2023-08-17
+
+### Added
+
+- Add sample Docker test configuration for daemon processes
+- Add support for coverage HTML report
+
+### Fixed
+
+- Fix few invoke task arguments and help
+
+
+## [0.1.7] - 2023-08-04
+
+### Changed
+
+- Update dependencies
+
+## [0.1.6] - 2023-07-26
+
+### Changed
+
+- Enhance CI to do more tests regarding Docker and Python build and publish dev image
+
+## [0.1.5] - 2023-07-24
+
+### Changed
+
+- Source Python version from pyproject.toml
+- Build Docker image in CI `Publish.yaml`
+
+### Fixed
+
+- Adjust Ruff rules ignored by default
+- Use `no-cache-dir` for package install
+
+## [0.1.4] - 2023-07-17
+
+### Added
+
+- Added debugpy
+
+## [0.1.3] - 2023-07-14
+
+### Added
+
+- Added a `check` feature in hatch
+- Added pyright wrapper to this feature
+- Installed this feature in `dev` environment
+- Used `check-pyright` task in QA workflow
+
+### Changed
+
+- Use major versions for workflows actions
+- Enable `dev` in default hatch environment
+
+## [0.1.2] - 2023-07-13
+
+### Fixed
+
+- Fix version to comply with SemVer
+
+## [0.1.1] - 2023-07-11
+
+### Added
+
+- Add the scripts to lint's features, otherwise we can use the hatch run lint:*
+
+
+## [0.1.0] - 2023-06-22
+
+### Added
+
+- Initial version

backend/README.md

@@ -0,0 +1 @@
+# Mirrors-QA

backend/alembic.ini

@@ -0,0 +1,113 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = src/backend/migrations
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to src/backend/migirations/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:src/backend/migirations/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+hooks = black ruff
+black.type = console_scripts
+black.entrypoint = black
+black.options = REVISION_SCRIPT_FILENAME
+ruff.type = exec
+ruff.executable = ruff
+ruff.options = format REVISION_SCRIPT_FILENAME
+
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S