Statically populate the `known_third_party` `isort` setting.
Project description
seed-isort-config
Statically populate the known_third_party
isort
setting.
isort
when run in isolation is not the best at determining what
dependencies are third party.
aspy.refactor_imports
is fortunately much better at
this static analysis.
Why not just use reorder-python-imports
? Well, it
lacks a few features provided by isort
(intentionally).
What this script does is seeds the known_third_party
isort configuration
automatically.
install
pip install seed-isort-config
usage
seed-isort-config
provides a single executable by the same name. Run it
inside a git
repository.
To specify custom application roots (such as with the src
pattern) pass a
colon-separated --application-directories
parameter.
Files may be excluded from the process using the --exclude
flag.
This argument takes a python regular expression.
For a full list of arguments, see seed-isort-config --help
.
getting started
seed-isort-config
looks for an existing known_third_party
setting in an
isort configuration file. It will modify that if it exists, otherwise it'll
create a brand new .isort.cfg
file.
The easiest way to get started is to just add a blank known_third_party =
section to your isort configuration (or known_third_party = []
if you are
using pyproject.toml
).
usage with pre-commit
This works especially well when integrated with pre-commit
.
- repo: https://github.com/asottile/seed-isort-config
rev: v2.0.0
hooks:
- id: seed-isort-config
- repo: https://github.com/timothycrosley/isort
rev: 4.3.21 # pick the isort version you'd like to use from https://github.com/timothycrosley/isort/releases
hooks:
- id: isort
In this configuration, seed-isort-config
will adjust the known_third_party
section of the isort
configuration before isort
runs!
Note that seed-isort-config
doesn't act like a normal pre-commit linter so
file exclusion must be configured through args: [--exclude=...]
instead.
For example: args: [--exclude=tests/.*\.py]
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file seed_isort_config-2.0.0.tar.gz
.
File metadata
- Download URL: seed_isort_config-2.0.0.tar.gz
- Upload date:
- Size: 5.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98656281c241becb5a942da4db47f267808eef0f1fae7904e27eeebf7a5ee660 |
|
MD5 | 690381e196d78517c94ef47312d719df |
|
BLAKE2b-256 | 6fd3319f177a7de2ebe176a1e51845d07245e1f394c288ef21feb4877b37013a |
Provenance
File details
Details for the file seed_isort_config-2.0.0-py2.py3-none-any.whl
.
File metadata
- Download URL: seed_isort_config-2.0.0-py2.py3-none-any.whl
- Upload date:
- Size: 5.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e03e91ba6ad3d7e598ac59d792e60f5452ed395a36c058335b79d625a5f7cb7e |
|
MD5 | dbc0335b71bacd882a553d18c89db81c |
|
BLAKE2b-256 | da5a3266e4be086045aaf22eb0cc606bf38fe107014ab57b759312ddc56720d2 |