Skip to content

Commit e5a2714

Browse files
committed
update doc for isort
1 parent ff596fc commit e5a2714

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

.pre-commit-config.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ repos:
88
rev: 3.8.4
99
hooks:
1010
- id: flake8
11-
# additional_dependencies:
12-
# - flake8-import-order
1311
- repo: https://github.com/asottile/pyupgrade
1412
rev: v2.7.4
1513
hooks:

CONTRIBUTING.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ Travis runs the tests against the main Python 3.x versions.
3535
Style Guide
3636
-----------
3737

38-
MongoEngine's codebase is formatted with `black <https://github.com/python/black>`_, other tools like
39-
flake8 are also used. Those tools will run as part of the CI and will fail in case the code is not formatted properly.
38+
MongoEngine's codebase is auto-formatted with `black <https://github.com/python/black>`_, imports are ordered with `isort <https://pycqa.github.io/isort/>`_
39+
and other tools like flake8 are also used. Those tools will run as part of the CI and will fail in case the code is not formatted properly.
4040

4141
To install all development tools, simply run the following commands:
4242

@@ -58,6 +58,10 @@ To enable ``pre-commit`` simply run:
5858
See the ``.pre-commit-config.yaml`` configuration file for more information
5959
on how it works.
6060

61+
pre-commit will now run upon every commit and will reject anything that doesn't comply.
62+
63+
You can also run all the checks with ``pre-commit run -a``, this is what is used in the CI.
64+
6165
Testing
6266
-------
6367

requirements-dev.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
black
22
flake8
3-
flake8-import-order
43
pre-commit
54
pytest
65
ipdb

setup.cfg

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
ignore=E501,F403,F405,I201,I202,W504,W605,W503,B007
33
exclude=build,dist,docs,venv,venv3,.tox,.eggs,tests
44
max-complexity=47
5-
application-import-names=mongoengine,tests
65

76
[tool:pytest]
87
# Limits the discovery to tests directory

0 commit comments

Comments
 (0)