From bd14505afaccc3c90359198d8f730bc75f6da79a Mon Sep 17 00:00:00 2001
From: David Douard <david.douard@sdfa3.org>
Date: Fri, 1 Dec 2023 18:40:49 +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 | 5 +++--
tox.ini | 11 +++++------
7 files changed, 18 insertions(+), 10 deletions(-)
diff --git a/.copier-answers.yml b/.copier-answers.yml
index 2d053422..2c24d6fd 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 deposit server
distribution_name: swh-deposit
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 6dd3da15..8dab8558 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -31,6 +31,9 @@ repos:
name: Check source code spelling
args: [-L sur]
stages: [commit]
+ - id: codespell
+ name: Check commit message spelling
+ stages: [commit-msg]
- repo: local
hooks:
diff --git a/docs/Makefile b/docs/Makefile
index 3437a487..ac4259f2 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,4 +1,4 @@
-include swh-docs/Makefile.sphinx
+include Makefile.sphinx
APIDOC_EXCLUDES += ../swh/*/settings/*
diff --git a/pyproject.toml b/pyproject.toml
index 0cc46a0f..092bd34b 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -63,3 +63,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 98c5ccf6..04c78b48 100644
--- a/pytest.ini
+++ b/pytest.ini
@@ -1,10 +1,11 @@
[pytest]
# Remove the pytest_swh_* entries when they stop getting imported automatically
-addopts = --ignore=swh/deposit/settings -p no:flask -p no:pytest_swh_scheduler -p no:pytest_swh_storage -p no:pytest_swh_core
+addopts = --import-mode=importlib --ignore=swh/deposit/settings -p no:flask -p no:pytest_swh_scheduler -p no:pytest_swh_storage -p no:pytest_swh_core
norecursedirs = build docs .*
+asyncio_mode = strict
+
DJANGO_SETTINGS_MODULE = swh.deposit.settings.testing
markers =
db: execute tests using a postgresql database
fs: execute tests using the filesystem
-asyncio_mode = strict
diff --git a/tox.ini b/tox.ini
index b511d7dd..5ce2689b 100644
--- a/tox.ini
+++ b/tox.ini
@@ -21,21 +21,20 @@ deps =
django3: Django>=3,<4
commands =
pytest --doctest-modules \
- --import-mode importlib \
--rootdir {envsitepackagesdir} \
--cov={envsitepackagesdir}/swh/deposit \
--cov-branch \
--ignore {envsitepackagesdir}/swh/deposit/settings/ \
{envsitepackagesdir}/swh/deposit \
{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
@@ -73,4 +72,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