The auth command group implementation has been moved to the swh-auth
package so deprecate "swh web auth" commands in favor of "swh auth".

Until removal, previous commands are now simply forwarded to swh-auth
ones.

Closes T3385

Enable to check package documentation can be built without producing
sphinx warnings.

The sphinx environment is designed to be used in continuous integration
in order to prevent breaking documentation build when committing changes.

The sphinx-dev environment is designed to be used inside a full swh
development environment.

Related to T3258

Related to T3278

Closes T2872.

Closes T2873.

Close T2822.

Rename login subcommand to generate-token and logout subcommand
to revoke-token.

Antoine Eiche authored 4 years ago and Antoine R. Dumont committed 4 years ago

From the model specification, the date attribute in Revision and
Release objects is optional. This commit handles the date attribute
set to the None value.

It also tests the "typification" of a minimal Revision object to avoid
regressions on this usecase.

Closes T2646.

We now use separate branches for this.

Related to T2610

Related to T2610

flake8 hook has been removed from https://github.com/pre-commit/pre-commit-hooks
so now use the one from https://gitlab.com/pycqa/flake8

by moving import statements in functions.

Related to T2575.

so loading the cli sunmodule does not trigger the loading of
230+ modules.

Related to T2575.

Token renewal workflow is now delegated to swh-web for commodity of use when
a user wants to make authenticated API calls.

So remove no more needed code and update documentation regarding authentication.

pytest wastes a lot of time in .hypothesis and .git; this commit excludes them.

Related to T2501

A test is added to ensure the pagination and the data typing are
working as expected.

Related to T2367

- blackify all the python files,
- enable black in pre-commit,
- add a black tox environment.

By providing a refresh token, obtained with the "swh auth login" command
to the new authenticate method of the client, all emitted requests will
be authenticated using a bearer token sent in headers.

Related to T1927

Usage: swh auth [OPTIONS] COMMAND [ARGS]...

  Authenticate Software Heritage users with OpenID Connect.

  This CLI tool eases the retrieval of bearer tokens to authenticate a user
  querying the Software Heritage Web API.

Options:
  --oidc-server-url TEXT  URL of OpenID Connect server (default to
                          "https://auth.softwareheritage.org/auth/")
  --realm-name TEXT       Name of the OpenID Connect authentication realm
                          (default to "SoftwareHeritage")
  --client-id TEXT        OpenID Connect client identifier in the realm
                          (default to "swh-web")
  -h, --help              Show this message and exit.

Commands:
  login    Login and create new offline OpenID Connect session.
  logout   Logout from an offline OpenID Connect session.
  refresh  Refresh an offline OpenID Connect session.

Closes T2268

Sphinx directives are not accepted as descriptions on PyPI, so we should remove
them from README. To that end, refactor README as a doc fragmented which is
linked from root dir (pointing to docs/README.rst) and included into
docs/index.rst.