Merge pull request #128 from openzim/adopt_bootstrap

Migrate to python bootstrap conventions

Author: benoit74

.github/workflows/Publish.yaml

@@ -0,0 +1,28 @@
+name: Build and upload to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-22.04
+    permissions:
+      id-token: write  # mandatory for PyPI trusted publishing
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version-file: pyproject.toml
+          architecture: x64
+
+      - name: Build packages
+        run: |
+          pip install -U pip build
+          python -m build --sdist --wheel
+
+      - name: Upload to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1.8

.github/workflows/QA.yaml

@@ -0,0 +1,34 @@
+name: 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: pyproject.toml
+          architecture: x64
+
+      - name: Install dependencies (and project)
+        run: |
+          pip install -U pip
+          pip install -e .[lint,scripts,test,check]
+
+      - name: Check black formatting
+        run: inv lint-black
+
+      - name: Check ruff
+        run: inv lint-ruff
+
+      - name: Check pyright
+        run: inv check-pyright

.github/workflows/Tests.yaml

@@ -0,0 +1,60 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  run-tests:
+    strategy:
+      matrix:
+        os: [ubuntu-22.04]
+        python: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: install ffmpeg and gifsicle
+        run: sudo apt update && sudo apt install ffmpeg gifsicle
+
+      - name: add required locales for tests
+        run: sudo locale-gen fr_FR.UTF-8 pt_BR.UTF-8 && sudo update-locale
+
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+          architecture: x64
+
+      - name: Install dependencies (and project)
+        run: |
+          pip install -U pip
+          pip install -e .[test,scripts]
+
+      - name: Run the tests
+        run: inv coverage --args "--runslow -vvv"
+
+      - name: Upload coverage report to codecov
+        if: matrix.python == '3.12'
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  build_python:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version-file: pyproject.toml
+          architecture: x64
+
+      - name: Ensure we can build Python targets
+        run: |
+          pip install -U pip build
+          python3 -m build --sdist --wheel

.github/workflows/ci.yml

@@ -248,3 +248,7 @@ $RECYCLE.BIN/
 *.lnk
 
 # End of https://www.toptal.com/developers/gitignore/api/python,macos,windows,linux
+
+# ignore all vscode, this is not standard configuration in this place
+.vscode
+src/libzim-stubs

.github/workflows/release.yml

@@ -1,22 +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.4.0
-    hooks:
-    -   id: trailing-whitespace
-    -   id: end-of-file-fixer
--   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.1.0"
-    hooks:
-    -   id: black
--   repo: https://github.com/pycqa/flake8
-    rev: "6.0.0"
-    hooks:
-    -   id: flake8
-        args: ["--max-line-length", "88", "--extend-ignore=E203"]
+- 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.1
+  hooks:
+  - id: ruff
+- repo: https://github.com/RobertCraigie/pyright-python
+  rev: v1.1.350
+  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'

.gitignore

@@ -5,6 +5,14 @@ All notable changes to this project are 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) (as of version 1.5.0).
 
+## [Unreleased]
+
+### Changed
+
+- Using openZIM Python bootstrap conventions (including hatch-openzim plugin) #120
+- Suuport for Python 3.12, drop Python 3.7 #118
+- Replace "iso-369" iso639-lang by "iso639-lang" library
+
 ## [3.2.0] - 2023-12-16
 
 ### Added

.pre-commit-config.yaml

@@ -47,27 +47,29 @@ sudo apt install libmagic1 wget ffmpeg \
 
 # Contribution
 
+This project adheres to openZIM's [Contribution Guidelines](https://github.com/openzim/overview/wiki/Contributing)
+
 ```shell
-pip -r requirements.txt
-pip install tox pre-commit
+pip install hatch
+pip install ".[dev]"
 pre-commit install
 # For tests
-tox
+invoke coverage
 ```
 
 # Users
 
 Non-exhaustive list of scrapers using it (check status when updating API):
 
-* [openzim/youtube](https://github.com/openzim/youtube)
+* [openzim/freecodecamp](https://github.com/openzim/freecodecamp)
+* [openzim/gutenberg](https://github.com/openzim/gutenberg)
+* [openzim/ifixit](https://github.com/openzim/ifixit)
+* [openzim/kolibri](https://github.com/openzim/kolibri)
 * [openzim/nautilus](https://github.com/openzim/nautilus)
-
-# releasing
-
-* Update your dependencies: `pip install -U setuptools wheel twine`
-* Make sure CHANGELOG.md is up-to-date
-* Bump version on `src/zimscraperlib/VERSION`
-* Build packages `python ./setup.py sdist bdist_wheel`
-* Upload to PyPI `twine upload dist/zimscraperlib-2.0.0*`.
-* Commit your Changelog + version bump changes
-* Tag version on git `git tag -a v2.0.0`
+* [openzim/nautilus](https://github.com/openzim/nautilus)
+* [openzim/openedx](https://github.com/openzim/openedx)
+* [openzim/sotoki](https://github.com/openzim/sotoki)
+* [openzim/ted](https://github.com/openzim/ted)
+* [openzim/warc2zim](https://github.com/openzim/warc2zim)
+* [openzim/wikihow](https://github.com/openzim/wikihow)
+* [openzim/youtube](https://github.com/openzim/youtube)