Skip to content

Commit

Permalink
[Docs] Replace black/flake8 with pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
cas-- committed Sep 8, 2024
1 parent 0d72195 commit d064ad0
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 24 deletions.
23 changes: 11 additions & 12 deletions docs/source/contributing/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,18 +51,19 @@ time. They are both run with [pre-commit].

We follow [PEP8](http://www.python.org/dev/peps/pep-0008/) and
[Python Code Style](http://docs.python-guide.org/en/latest/writing/style/)
which is adhered to with [Black].
which is adhered to with [ruff].

- Code '''must''' pass [Black], [flake8] and [isort] source code checkers.
(Optionally [Pylint])
- Code **must** pass [ruff] linting and formatting with [pre-commit]:

flake8 deluge
isort -rc -df deluge
pylint deluge
pylint deluge/plugins/\*/deluge/
pre-commit run --all-files

- Using the [pre-commit] application can aid in identifying issues while
creating git commits.
- Optionally [Pylint]:

pylint deluge
pylint deluge/plugins/\*/deluge/

- Installing the [pre-commit] application can aid in identifying issues
while creating git commits.

#### Strings and bytes

Expand Down Expand Up @@ -116,9 +117,7 @@ Verify that the documentation parses correctly with:
python setup.py build_docs

[pre-commit]: http://pre-commit.com/
[flake8]: https://pypi.python.org/pypi/flake8
[isort]: https://pypi.python.org/pypi/isort
[ruff]: https://docs.astral.sh/ruff/
[pylint]: http://www.pylint.org/
[black]: https://github.com/python/black/
[gtk3 unicode]: http://python-gtk-3-tutorial.readthedocs.org/en/latest/unicode.html
[napoleon sections]: http://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#docstring-sections
7 changes: 0 additions & 7 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,4 @@
sphinx-autobuild
tox
pre-commit
flake8-blind-except
flake8-builtins
flake8-commas
flake8-comprehensions
flake8-debugger
flake8-mock
flake8-mutable
rjsmin
5 changes: 0 additions & 5 deletions requirements-tests.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,5 @@ pytest-twisted
pytest-cov
mock
pre-commit
flake8<=3.7.9
flake8-quotes
flake8-isort
pep8-naming
mccabe
pylint
asyncmock; python_version <= '3.7'

0 comments on commit d064ad0

Please sign in to comment.