apply a consistent format to `setup.cfg` files

These details have not been verified by PyPI

Project links

Homepage

Project description

setup-cfg-fmt

apply a consistent format to setup.cfg files

installation

pip install setup-cfg-fmt

as a pre-commit hook

See pre-commit for instructions

Sample .pre-commit-config.yaml:

-   repo: https://github.com/asottile/setup-cfg-fmt
    rev: v2.6.0
    hooks:
    -   id: setup-cfg-fmt

cli

Consult the help for the latest usage:

$ setup-cfg-fmt --help

what does it do?

sets a consistent ordering for attributes

For example, name and version (the most important metadata) will always appear at the top.

 [metadata]
-version = 1.14.4
-name = pre_commit
+name = pre_commit
+version = 1.14.4

normalizes dashes to underscores in project name

pip will normalize names to dashes foo_bar => foo-bar
python setup.py sdist produces a filename with the name verbatim
pip wheel . produces a filename with an underscore-normalized name

$ # with dashed name
$ python setup.py sdist && pip wheel -w dist .
...
$ ls dist/ | cat
setup_cfg_fmt-0.0.0-py2.py3-none-any.whl
setup-cfg-fmt-0.0.0.tar.gz
$ # with underscore name
$ python setup.py sdist && pip wheel -w dist .
...
$ ls dist/ | cat
setup_cfg_fmt-0.0.0-py2.py3-none-any.whl
setup_cfg_fmt-0.0.0.tar.gz

This makes it easier to upload packages to pypi since they end up with the same filename prefix.

 [metadata]
-name = pre-commit
+name = pre_commit

normalizes dashes to underscores in keys

setuptools allows dashed names but does not document them.

 [metadata]
 name = pre-commit
-long-description = file: README.md
+long_description = file: README.md

adds `long_description` if `README` is present

This will show up on the pypi project page

 [metadata]
 name = pre_commit
 version = 1.14.5
+long_description = file: README.md
+long_description_content_type = text/markdown

adds `license_file` / `license` / license classifier if `LICENSE` exists

 [metadata]
 name = pre_commit
 version = 1.14.5
+license = MIT
+license_file = LICENSE
+classifiers =
+    License :: OSI Approved :: MIT License

set `python_requires`

A few sources are searched for guessing python_requires:

the existing python_requires setting itself
envlist in tox.ini if present
python version classifiers that are already set
the --min-py-version argument

adds python version classifiers

classifiers are generated based on:

the python_requires setting
the --max-py-version argument
--include-version-classifiers is specified

 name = pkg
 version = 1.0
+classifiers =
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    Programming Language :: Python :: 3.11
+    ...

without --include-version-classifiers only the major version will be included:

 name = pkg
 version = 1.0
+classifiers =
+    Programming Language :: Python :: 3

sorts classifiers

 [metadata]
 name = pre_commit
 version = 1.14.5
 classifiers =
-    Programming Language :: Python :: 3
-    License :: OSI Approved :: MIT License
+    License :: OSI Approved :: MIT License
+    Programming Language :: Python :: 3
     Programming Language :: Python :: 3.6

removes empty options in any section

 [options]
-dependency_links =
 python_requires = >= 3.6.1

related projects

setup-py-upgrade: automatically migrate setup.py -> setup.cfg

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

2.7.0

Oct 11, 2024

This version

2.6.0

Oct 11, 2024

2.5.0

Oct 2, 2023

2.4.0

Jul 1, 2023

2.3.0

Jun 1, 2023

2.2.0

Oct 24, 2022

2.1.0

Oct 15, 2022

2.0.0

Jul 31, 2022

1.20.2

Jul 22, 2022

1.20.1

Apr 2, 2022

1.20.0

Nov 19, 2021

1.19.0

Oct 30, 2021

1.18.0

Oct 4, 2021

1.17.0

Mar 14, 2021

1.16.0

Dec 16, 2020

1.15.1

Oct 26, 2020

1.15.0

Oct 11, 2020

1.14.0

Oct 5, 2020

1.13.0

Oct 5, 2020

1.12.0

Oct 4, 2020

1.11.0

Jul 22, 2020

1.10.0

Jul 7, 2020

1.9.0

Apr 17, 2020

1.8.2

Mar 25, 2020

1.8.1

Mar 25, 2020

1.8.0

Mar 25, 2020

1.7.0

Feb 25, 2020

1.6.0

Oct 17, 2019

1.5.0

Jul 2, 2019

1.4.0

Jun 28, 2019

1.3.0

Jun 28, 2019

1.2.1

Jun 24, 2019

1.2.0

Jun 24, 2019

1.1.0

Apr 8, 2019

1.0.0

Feb 28, 2019

0.0.5

Feb 28, 2019

0.0.4

Feb 28, 2019

0.0.3

Feb 28, 2019

0.0.2

Feb 24, 2019

0.0.1

Feb 19, 2019

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

setup_cfg_fmt-2.6.0.tar.gz (8.1 kB view details)

Uploaded Oct 11, 2024 Source

Built Distribution

setup_cfg_fmt-2.6.0-py2.py3-none-any.whl (8.7 kB view details)

Uploaded Oct 11, 2024 Python 2 Python 3

File details

Details for the file setup_cfg_fmt-2.6.0.tar.gz.

File metadata

Download URL: setup_cfg_fmt-2.6.0.tar.gz
Upload date: Oct 11, 2024
Size: 8.1 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for setup_cfg_fmt-2.6.0.tar.gz
Algorithm	Hash digest
SHA256	`64f0c4eb34e65534f9b8b01003c162351859770bf59fb8e7286a56fded9dc44f`
MD5	`dc1c4b64dd9057bc8cc3b496a1cfef1c`
BLAKE2b-256	`8ccb8d27db14d9a86303e5fc380c3a61a9b90daa7058f37181a2852a798497bf`

See more details on using hashes here.

Provenance

File details

Details for the file setup_cfg_fmt-2.6.0-py2.py3-none-any.whl.

File metadata

Download URL: setup_cfg_fmt-2.6.0-py2.py3-none-any.whl
Upload date: Oct 11, 2024
Size: 8.7 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for setup_cfg_fmt-2.6.0-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`c0bcbb9c6ec6e11b5a953bf92c1798cd7b749b15f45436da829481fa41576fbe`
MD5	`010c16a481870a5aaada5996125188a0`
BLAKE2b-256	`93ddd3213980b8f6e609a622dca581162738d7f6d3f75b1e286e13b467a7dd44`