.copier-answers.yml

+# Changes here will be overwritten by Copier
+_commit: v0.3.3
+_src_path: https://gitlab.softwareheritage.org/swh/devel/swh-py-template.git
+description: Software Heritage core utilities
+distribution_name: swh-core
+have_cli: true
+have_workers: false
+package_root: swh/core
+project_name: swh.core
+python_minimal_version: '3.7'
+readme_format: rst

.git-blame-ignore-revs

-# Enable black.
+# python: Reformat code with black
 cdd8268f9f0320452b445a09a85de89e1fc86090
-
-# python: Reformat code with black 22.3.0
 410cf44d652a99b20d6e69063ed2d8d991394f4f
+3b1a41e4cad12544f684a6fca6e21105c8e31236

.gitignore

+*.egg-info/
 *.pyc
-*.sw?
-*~
-/.coverage
-/.coverage.*
+.coverage
 .eggs/
-__pycache__
-build
-dist
-swh.core.egg-info
-version.txt
-.tox
 .hypothesis
-.mypy_cache/
+.mypy_cache
+.tox
+__pycache__
+build/
+dist/
+# these are symlinks created by a hook in swh-docs' main sphinx conf.py
+docs/README.rst
+docs/README.md
+# this should be a symlink for people who want to build the sphinx doc
+# without using tox, generally created by the swh-env/bin/update script
+docs/Makefile.sphinx

.pre-commit-config.yaml

 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: check-json
       - id: check-yaml
 
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: 4.0.1
+  - repo: https://github.com/python/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 6.0.0
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.1.1
     hooks:
       - id: flake8
-        additional_dependencies: [flake8-bugbear==22.3.23]
+        additional_dependencies: [flake8-bugbear==24.12.12, flake8-pyproject]
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.1.0
+    rev: v2.4.1
     hooks:
       - id: codespell
         name: Check source code spelling
         args: [-L crate]
-        stages: [commit]
+        stages: [pre-commit]
+      - id: codespell
+        name: Check commit message spelling
+        stages: [commit-msg]
 
   - repo: local
     hooks:
@@ -29,13 +42,13 @@ repos:
         pass_filenames: false
         language: system
         types: [python]
-
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
-    hooks:
-      - id: isort
-
-  - repo: https://github.com/python/black
-    rev: 22.3.0
-    hooks:
-      - id: black
+      - id: twine-check
+        name: twine check
+        description: call twine check when pushing an annotated release tag
+        entry: bash -c "ref=$(git describe) &&
+          [[ $ref =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]] &&
+          (python3 -m build --sdist && twine check $(ls -t dist/* | head -1)) || true"
+        pass_filenames: false
+        stages: [pre-push]
+        language: python
+        additional_dependencies: [twine, build]

CODE_OF_CONDUCT.md

@@ -6,7 +6,7 @@ In the interest of fostering an open and welcoming environment, we as Software
 Heritage contributors and maintainers pledge to making participation in our
 project and our community a harassment-free experience for everyone, regardless
 of age, body size, disability, ethnicity, sex characteristics, gender identity
-and expression, level of experience, education, socio-economic status,
+and expression, level of experience, education, socioeconomic status,
 nationality, personal appearance, race, religion, or sexual identity and
 orientation.
 

CONTRIBUTORS

 Thibault Allançon
+Franck Bret

MANIFEST.in

-include Makefile
-include conftest.py
-include requirements*.txt
-include version.txt
-recursive-include swh/core/db/sql *.sql
-recursive-include swh py.typed
-recursive-include swh/core/db/tests/data/ *
-recursive-include swh/core/tests/data/ *
-recursive-include swh/core/tests/fixture/data/ *

docs/Makefile

-include ../../swh-docs/Makefile.sphinx
+include Makefile.sphinx

docs/cli.rst

@@ -9,6 +9,38 @@ Shared command-line interface
 .. click:: swh.core.cli:swh
   :prog: swh
 
+Shell Completion
+----------------
+
+You may activate the command line completion mechanism for your shell. The
+`swh` tool is using the `click`_ package, so activating command completion is a
+simple matter of:
+
+.. tab-set::
+
+   .. tab-item:: Bash
+
+      Add this to your `.bashrc`
+
+      .. code-block:: bash
+
+         eval "$(_SWH_COMPLETE=bash_source swh)"
+
+   .. tab-item:: Zsh
+
+      Add this to your `.zshrc`
+
+      .. code-block:: zsh
+
+         eval "$(_SWH_COMPLETE=zsh_source swh)"
+
+
+See `click documentation`_ for more details and options.
+
+.. _`click`: https://click.palletsprojects.com
+.. _`click documentation`: https://click.palletsprojects.com/en/8.1.x/shell-completion
+
+
 Database initialization utilities
 ---------------------------------
 

docs/db.rst

@@ -114,8 +114,8 @@ conditions are expected:
   returning an instance of the datastore object. Normally, this datastore
   object uses ``swh.core.db.BaseDb`` to interact with the actual database.
 
-- The datastore object should provide a ``get_current_version()`` method
-  returning the database version expected by the code.
+- The datastore object should provide a ``current_version`` attribute returning the
+  database version expected by the code.
 
 See existing ``swh`` packages like ``swh.storage`` or ``swh.scheduler`` for
 usage examples.
@@ -126,7 +126,7 @@ Writing tests
 The ``swh.core.db.pytest_plugin`` provides a few helper tools to write unit
 tests for postgresql based datastores.
 
-By default, when using these fixtures, a posgresql server will be started (by
+By default, when using these fixtures, a postgresql server will be started (by
 the pytest_postgresql fixture) and a template database will be created using
 the ``postgresql_proc`` fixture factory provided by ``pytest_postgresql``.
 

docs/index.rst

@@ -10,4 +10,12 @@ Reference Documentation
 
    cli
    db
-   /apidoc/swh.core
+
+.. only:: standalone_package_doc
+
+   Indices and tables
+   ------------------
+
+   * :ref:`genindex`
+   * :ref:`modindex`
+   * :ref:`search`

mypy.ini

-[mypy]
-namespace_packages = True
-warn_unused_ignores = True
-
-
-# 3rd party libraries without stubs (yet)
-
-[mypy-aiohttp_utils.*]
-ignore_missing_imports = True
-
-[mypy-arrow.*]
-ignore_missing_imports = True
-
-[mypy-celery.*]
-ignore_missing_imports = True
-
-[mypy-decorator.*]
-ignore_missing_imports = True
-
-[mypy-deprecated.*]
-ignore_missing_imports = True
-
-[mypy-django.*]  # false positive, only used my hypotesis' extras
-ignore_missing_imports = True
-
-[mypy-iso8601.*]
-ignore_missing_imports = True
-
-[mypy-magic.*]
-ignore_missing_imports = True
-
-[mypy-msgpack.*]
-ignore_missing_imports = True
-
-[mypy-pkg_resources.*]
-ignore_missing_imports = True
-
-[mypy-pytest.*]
-ignore_missing_imports = True
-
-[mypy-pytest_postgresql.*]
-ignore_missing_imports = True
-
-[mypy-requests_mock.*]
-ignore_missing_imports = True
-
-[mypy-systemd.*]
-ignore_missing_imports = True

pyproject.toml

+[project]
+name = "swh.core"
+authors = [
+    {name="Software Heritage developers", email="swh-devel@inria.fr"},
+]
+
+description = "Software Heritage core utilities"
+readme = {file = "README.rst", content-type = "text/x-rst"}
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: OS Independent",
+    "Development Status :: 5 - Production/Stable",
+]
+dynamic = ["version", "dependencies", "optional-dependencies"]
+
+[tool.setuptools.packages.find]
+include = ["swh.*"]
+
+[tool.setuptools.dynamic]
+dependencies = {file = "requirements.txt"}
+
+[tool.setuptools.dynamic.optional-dependencies]
+testing_core = {file = "requirements-test.txt"}
+logging = {file = ["requirements-logging.txt"]}
+db = {file = ["requirements-db.txt"]}
+http = {file = "requirements-http.txt"}
+# kitchen sink, please do not use
+testing = {file = [
+        "requirements-test.txt",
+        "requirements-logging.txt",
+        "requirements-http.txt",
+        "requirements-db.txt"]}
+
+[project.entry-points.console_scripts]
+"swh" = "swh.core.cli:main"
+
+[project.entry-points."swh.cli.subcommands"]
+"swh.core.db" = "swh.core.cli.db"
+"swh.core.backend" = "swh.core.cli.backend"
+"swh.core.sentry" = "swh.core.cli.sentry"
+
+[project.entry-points.pytest11]
+"pytest_swh_core" = "swh.core.pytest_plugin"
+
+[project.urls]
+"Homepage" = "https://gitlab.softwareheritage.org/swh/devel/swh-core"
+"Bug Reports" = "https://gitlab.softwareheritage.org/swh/devel/swh-core/-/issues"
+"Funding" = "https://www.softwareheritage.org/donate"
+"Documentation" = "https://docs.softwareheritage.org/devel/swh-core/"
+"Source" = "https://gitlab.softwareheritage.org/swh/devel/swh-core.git"
+
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+fallback_version = "0.0.1"
+
 [tool.black]
-target-version = ['py37']
+target-version = ['py39', 'py310', 'py311', 'py312']
 
 [tool.isort]
 multi_line_output = 3
@@ -9,3 +70,39 @@ use_parentheses = true
 ensure_newline_before_comments = true
 line_length = 88
 force_sort_within_sections = true
+known_first_party = ['swh']
+
+[tool.mypy]
+namespace_packages = true
+warn_unused_ignores = true
+explicit_package_bases = true
+# ^ Needed for mypy to detect py.typed from swh packages installed
+# in editable mode
+
+plugins = []
+
+# 3rd party libraries without stubs (yet)
+[[tool.mypy.overrides]]
+module = [
+    "aiohttp_utils.*",
+    "backports.entry_points_selectable.*",
+    "systemd.*",
+]
+ignore_missing_imports = true
+
+[tool.flake8]
+select = ["C", "E", "F", "W", "B950"]
+ignore = [
+    "E203", # whitespaces before ':' <https://github.com/psf/black/issues/315>
+    "E231", # missing whitespace after ','
+    "E501", # line too long, use B950 warning from flake8-bugbear instead
+    "W503" # line break before binary operator <https://github.com/psf/black/issues/52>
+]
+max-line-length = 88
+extend-exclude = ".git,.tox,.mypy_cache,build,dist"
+
+
+[tool.pytest.ini_options]
+norecursedirs = "build docs .*"
+asyncio_mode = "strict"
+consider_namespace_packages = true

pytest.ini

-[pytest]
-norecursedirs = build docs .*
-filterwarnings =
-  ignore:.*uses the 'db_with_data' fixture

requirements-db-pytestplugin.txt

-# requirements for swh.core.db.pytest_plugin
-pytest-postgresql >=3, < 4.0.0  # version 4.0 depends on psycopg 3. https://github.com/ClearcodeHQ/pytest-postgresql/blob/main/CHANGES.rst#400

requirements-db.txt

 # requirements for swh.core.db
-psycopg2
+psycopg
+psycopg_pool
 typing-extensions

requirements-github.txt

-# requirements for swh.core.github
-requests
-tenacity

requirements-test.txt

+celery-types
 hypothesis >= 3.11.0
-pytest
+msgpack-types
+pytest >= 8.1
 pytest-mock
+pytest-postgresql > 5
 pytz
 requests-mock
-types-click
-types-flask
-types-psycopg2
+types-deprecated
 types-pytz
 types-pyyaml
 types-requests
+types-setuptools

requirements.txt

+backports.entry_points_selectable
 click
 deprecated
 python-magic
 pyyaml
-sentry-sdk
+requests
+sentry-sdk >= 2
+tenacity >= 8.4.2

setup.cfg

-[flake8]
-# E203: whitespaces before ':' <https://github.com/psf/black/issues/315>
-# E231: missing whitespace after ','
-# E501: line too long, use B950 warning from flake8-bugbear instead
-# W503: line break before binary operator <https://github.com/psf/black/issues/52>
-select = C,E,F,W,B950
-ignore = E203,E231,E501,W503
-max-line-length = 88