Seamless Proxy CLI for black ("The uncompromising code formatter") with support for non-pyproject.toml config files
Project description
black-configparser
Seamless proxy CLI for black ("The uncompromising code formatter")
with support for non-pyproject.toml
config files.
Table of Contents
About the Project
The black-configparser
is yet another tool (next to brunette,
white, and maybe a few more out there),
which tries to fill the gap of missing setup.cfg
(or just any other non-pyproject.toml
) config file.
Why it is different?
Unlike other tools, tries to stay dumb simple and add only minimum needed overhead to black
usage.
- It is seamless - it works on the same CLI command -
black
- just passing logic through some extra code! - There is no complex argument processing, if config file is present, the values set there are passed directly to
black
. - Code of this tool is independent from
black
insides and will work properly as long asblack
won't make any braking changes in its command line options.
Installation
$ pip install black-configparser
Usage
- Supported configuration files:
setup.cfg
,tox.ini
. - Configuration file section:
[black]
or[tools:black]
.
Important! :warning:
- When you
black-configparser
finds black configuration in any of supported file(s), most black's built-in command line arguments become unavailable.
Exceptions:--check
--code
--diff
--help
--verbose
--version
- The
black-configparser
can be temporarily disabled, by adding--no-config-file
flag toblack
command, for example:$ black --no-config-file --check ./path/to/file.py
Example configuration
[black]
line-length = 120
target-version =
py27
py33
py34
py35
py36
py37
py38
pyi = True
skip-string-normalization = True
color = True
include = \.pyi?$
exclude = /(\.direnv|\.eggs|\.git|\.hg|\.mypy_cache|\.nox|\.tox|\.venv|\.svn|_build|buck-out|build|dist)/
force-exclude = lorem ipsum
quiet = True
verbose = True
- Almost any option available for black (
black --help
) can be put onto config file. - Values for multi-value arguments must be one per line (separated by
\n
char). - Flags (arguments without values) must be set in config file as
= True
.
Known issues
- Undefined behavior, when running with one of allowed CLI arguments which is also set in the config file.
- After
black-configparser
package is uninstalled, theblack
command does not work anymore and black package must be reinstalled.
License
MIT
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 black-configparser-0.2.0b2.tar.gz
.
File metadata
- Download URL: black-configparser-0.2.0b2.tar.gz
- Upload date:
- Size: 5.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60412e20bdef7c699b512e32f5f17a2b1310546fc670718e93b24bb64c79c5bb |
|
MD5 | e793be1d09c74dd721551a317a7a1eff |
|
BLAKE2b-256 | 670122a746e2af3c6191770816970a1f061f3c65e99e2fd99fd653db0efd4ccd |
File details
Details for the file black_configparser-0.2.0b2-py3-none-any.whl
.
File metadata
- Download URL: black_configparser-0.2.0b2-py3-none-any.whl
- Upload date:
- Size: 6.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.6.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a17f4e73a416303fa41641df22168234b54fce9c97f101697c731b726782b0d8 |
|
MD5 | 9bfb3d29df9da6463df4949f4d2c14b0 |
|
BLAKE2b-256 | 656d0f30b29810c08123c4a48869a489d5134fc5f8053e4850f7ee6a9249daa8 |