From 2d9d861ae636cdb8697e178a8acce01acc0e939d Mon Sep 17 00:00:00 2001 From: David Douard <david.douard@sdfa3.org> Date: Sun, 3 Dec 2023 17:47:24 +0100 Subject: [PATCH] Apply swh-py-template 0.1.6 --- .copier-answers.yml | 2 +- .gitignore | 4 ++++ .pre-commit-config.yaml | 3 +++ docs/Makefile | 2 +- pyproject.toml | 1 + pytest.ini | 12 +++++++----- tox.ini | 11 +++++------ 7 files changed, 22 insertions(+), 13 deletions(-) diff --git a/.copier-answers.yml b/.copier-answers.yml index ff6ad1f6..1fbba4a4 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,5 +1,5 @@ # Changes here will be overwritten by Copier -_commit: v0.1.5 +_commit: v0.1.6 _src_path: https://gitlab.softwareheritage.org/swh/devel/swh-py-template.git description: Software Heritage git loader distribution_name: swh-loader-git diff --git a/.gitignore b/.gitignore index 035b1395..d44f090f 100644 --- a/.gitignore +++ b/.gitignore @@ -8,5 +8,9 @@ __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 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 44882702..8957bec6 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -28,6 +28,9 @@ repos: - id: codespell name: Check source code spelling stages: [commit] + - id: codespell + name: Check commit message spelling + stages: [commit-msg] - repo: local hooks: diff --git a/docs/Makefile b/docs/Makefile index 85f23e85..8ac10a95 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1 +1 @@ -include swh-docs/Makefile.sphinx +include Makefile.sphinx diff --git a/pyproject.toml b/pyproject.toml index 1f37c360..98fd4059 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -55,3 +55,4 @@ use_parentheses = true ensure_newline_before_comments = true line_length = 88 force_sort_within_sections = true +known_first_party = ['swh'] diff --git a/pytest.ini b/pytest.ini index c5b77216..c265218f 100644 --- a/pytest.ini +++ b/pytest.ini @@ -1,9 +1,11 @@ [pytest] +norecursedirs = build docs .* +asyncio_mode = strict +addopts = + --import-mode=importlib + -p no:pytest_swh_scheduler + -p no:pytest_swh_storage + # Drop this when these fixtures aren't imported automatically -addopts = -p no:pytest_swh_scheduler -p no:pytest_swh_storage markers = fs: depends on writing to the filesystem - -norecursedirs = build docs .* - -asyncio_mode = strict diff --git a/tox.ini b/tox.ini index c9ec2f74..7246f4c8 100644 --- a/tox.ini +++ b/tox.ini @@ -13,20 +13,19 @@ deps = pytest-cov commands = pytest --doctest-modules \ - --import-mode importlib \ --rootdir {envsitepackagesdir} \ --cov={envsitepackagesdir}/swh/loader/git \ --cov-branch \ {envsitepackagesdir}/swh/loader/git \ {posargs} -# --rootdir and --import-mode are required to make tests that depends -# on the test file to be a proper submodule of the swh namespace after -# migration to PEP420 (implicit namespace). +# --rootdir (with --import-mode from pytest.ini) are required to make tests +# that depends on the test file to be a proper submodule of the swh namespace +# after migration to PEP420 (implicit namespace). [testenv:black] skip_install = true deps = - black==22.10.0 + black==23.1.0 commands = {envpython} -m black --check swh @@ -62,4 +61,4 @@ setenv = # turn warnings into errors SPHINXOPTS = -W commands = - make -I {env_dir}/share/ -C docs + make -I {env_dir}/share/swh-docs -C docs -- GitLab