diff options
| author | Calum Lind <calumlind+deluge@gmail.com> | 2024-09-08 19:32:06 +0200 |
|---|---|---|
| committer | Calum Lind <calumlind+deluge@gmail.com> | 2024-09-08 19:32:06 +0200 |
| commit | d064ad06c5f93c9596ae92238bf50e447a06af4c (patch) | |
| tree | 2da9e7d2f03ef24e37441cad3ff1e47445ffe892 | |
| parent | [Lint] Format code with ruff (diff) | |
| download | deluge-d064ad06c5f93c9596ae92238bf50e447a06af4c.tar.xz deluge-d064ad06c5f93c9596ae92238bf50e447a06af4c.zip | |
[Docs] Replace black/flake8 with pre-commit
| -rw-r--r-- | docs/source/contributing/code.md | 23 | ||||
| -rw-r--r-- | requirements-dev.txt | 7 | ||||
| -rw-r--r-- | requirements-tests.txt | 5 |
3 files changed, 11 insertions, 24 deletions
diff --git a/docs/source/contributing/code.md b/docs/source/contributing/code.md index 20ccb820b..f2e78ee33 100644 --- a/docs/source/contributing/code.md +++ b/docs/source/contributing/code.md @@ -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 @@ -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 diff --git a/requirements-dev.txt b/requirements-dev.txt index 7e1194457..c8e339d62 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -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 diff --git a/requirements-tests.txt b/requirements-tests.txt index a570108ad..346a27500 100644 --- a/requirements-tests.txt +++ b/requirements-tests.txt @@ -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' |