GitLab will display the content of the README file when browsing the
repository. But in case the file is a symlink, it will display the
path pointed by the symlink. There is a 6 year old issue about this:
https://gitlab.com/gitlab-org/gitlab/-/issues/15093

We can workaround the issue by having the content at the root of the
repository and a symlink to this file in the `docs/` directory.

Tested in swh/devel/swh-py-template!27

It also enables to remove the version restriction on psycopg2.

Related to swh/infra/sysadm-environment#4772

Jérémy Bobbio (Lunar) authored 2 years ago and Jérémy Bobbio (Lunar) committed 2 years ago

Related to swh/meta#4959

Related to swh/meta#4960

This fixes python 3.7 support due to poetry, a dependency of isort, that
removed support for that Python version in a recent release.

In order to remove warnings about /apidoc/*.rst files being included
multiple times in toc when building full swh documentation, prefer to
include module indices only when building standalone package documentation.

Also include them the proper sphinx way.

Related to T4496

- pre-commit from 4.1.0 to 4.3.0,
- codespell from 2.2.1 to 2.2.2,
- black from 22.3.0 to 22.10.0 and
- flake8 from 4.0.1 to 5.0.4. Also freeze flake8 dependencies.

Also change flake8's repo config to github (the gitlab mirror
being outdated).

The package declares (scheduler) tasks, it needs that dependency to work

Related to T4540

Setting the next_path query parameter is not required here as webapp login
view redirects by default to the homepage.

Related to T4399

[1] https://jenkins.softwareheritage.org/view/swh%20master%20(draft)/job/DDEP/job/tests/1947/console

That hook can be frustrating as it can discard a long commit message
if it finds a typo in it so better removing it.

It was always meant to be the latter, and it's also the only one that was implemented
in a release (as https://forge.softwareheritage.org/D7212 fixed the typo in the code
before it was released)

Those are not really of interest and generate a lof of noise when
executing django development server.

Add new private API endpoint /1/private/deposits/datatables/ to list and
filter deposits whose responses are intended to be consumed by datatables
javascript framework used in deposits admin Web UI.

Originally that view was implemented in swh-web but for performance reasons
it has been decided to move it in swh-deposit, swh-web will then simply
forward the HTTP request to swh-deposit.

Related to T3128

Related to T3922

black is considered stable since release 22.1.0 and the version
we are currently using is quite outdated and not compatible with
click 8.1.0, so it is time to bump it to its latest stable release.

Please note that E501 pycodestyle warning related to line length
is replaced by B950 one from flake8-bugbear as recommended by black.
https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length

Related to T3922

Looks like .tar.xz files just got slightly larger in Sid (Python 3.10 upgrade?),
which makes it go over the limit.

Resolves SWH-DEPOSIT-2P <https://sentry.softwareheritage.org/share/issue/b8509b67972f425a8f5c06805f8cf2fe/>

'metadata_raw' made sense, to discriminate from 'metadata_dict'; but no
longer does, now that the latter was removed.

Additionally, swh-web expects it to be named 'raw_metadata', so it
could never actually get the metadata.

pytest-postgresql 3.1.3 and pytest-redis 2.4.0 added support for
pytest >= 7 so we can now drop the pytest pinning.

Manually validate <codemeta:affiliation>. Unfortunately, this cannot be
validated by codemeta.xsd, because Codemeta has conflicting requirements:
1. https://codemeta.github.io/terms/ requires it to be Text (represented
   by simple content), but
2. https://doi.org/10.5063/SCHEMA/CODEMETA-2.0 requires it to be an
   Organization (represented by complex content)

See https://github.com/codemeta/codemeta/pull/239 for a discussion about
this issue.

Due to test modules being copied in subdirectories of the
build directory by setuptools, it makes pytest fail by raising
ImportPathMismatchError exceptions when invoked from root
directory of the module.

So ignore the build folder to discover tests.

They are allowed by ISO8601, via schema.org, via codemeta; but not by XML Schema's
date format.