diff options
| author | Timothy Crosley <timothy.crosley@gmail.com> | 2021-02-10 21:42:26 -0800 |
|---|---|---|
| committer | Timothy Crosley <timothy.crosley@gmail.com> | 2021-02-10 21:42:26 -0800 |
| commit | 2d13d5ad07ecff5a15e905a50cdbe5413921ebf9 (patch) | |
| tree | 0064bc7dd6135e1e135985bc1f02a98b519bb4e7 /docs | |
| parent | 8a9ad28563403edec26d1eced173e4e679cc6439 (diff) | |
| download | isort-2d13d5ad07ecff5a15e905a50cdbe5413921ebf9.tar.gz | |
Move setuptools integration to dedicated documentation page
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration/setuptools_integration.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/configuration/setuptools_integration.md b/docs/configuration/setuptools_integration.md new file mode 100644 index 00000000..ca2dbe56 --- /dev/null +++ b/docs/configuration/setuptools_integration.md @@ -0,0 +1,27 @@ +# Setuptools integration + +Upon installation, isort enables a `setuptools` command that checks +Python files declared by your project. + +Running `python setup.py isort` on the command line will check the files +listed in your `py_modules` and `packages`. If any warning is found, the +command will exit with an error code: + +```bash +$ python setup.py isort +``` + +Also, to allow users to be able to use the command without having to +install isort themselves, add isort to the setup\_requires of your +`setup()` like so: + +```python +setup( + name="project", + packages=["project"], + + setup_requires=[ + "isort" + ] +) +``` |
