Skip to main content
Logo

A formatter for finding and removing unused import statements.

Pycln Docs CI CD FUZZ Codecov

PYPI - Python Version PYPI - Pycln Version PyPI Downloads Downloads

Forks Stars Issues Pull Requests Contributors Last Commit License


Read the documentation on Github pages!


Installation and usage

Installation

Pycln requires Python 3.9+ and can be easily installed using the most common Python packaging tools. We recommend installing the latest stable release from PyPI with pipx

$ pip install pipx
$ pipx install pycln

Usage

By default Pycln will remove any unused import statement, So the simplest usage is to specify the path only:

$ pycln [PATH]

Also, it's possible to run pycln as a package:

$ python3 -m pycln [PATH]

NOTE: you may need to use -a/--all option for more satisfying results. see -a/--all flag.

Further information can be found in our docs:

Configuration

Pycln is able to read project-specific default values for its command line options from a configuration file like pyproject.toml or setup.cfg. This is especially useful for specifying custom CLI arguments/options like path/paths, --include, --exclude/--extend-exclude, or even --all.

You can find more details in our documentation:

And if you're looking for more general configuration documentation:

Used by

The following notable open-source projects trust and use Pycln:

The following organizations use Pycln:

Are we missing anyone? Let us know.

License

MIT

Contributing

A big welcome for considering contributing to make the project better!

You can get started by reading this:

You can also dive directly into the technicalities:

Change log

The log has become rather long. It moved to its own file.

See CHANGELOG.

Authors

The author list is quite long nowadays, so it lives in its own file.

See AUTHORS

Code of Conduct

Everyone participating in the Pycln project, and in particular in the issue tracker, and pull requests is expected to treat other people with respect.


Give a ⭐️ if this project helped you!

Metadata

Release files for pycln 2.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pycln 2.6.1
File Size Uploaded Provenance Actions
pycln-2.6.1.tar.gz 33.4 kB Without provenance Details for pycln-2.6.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pycln 2.6.1
File Interpreter ABI Platform Actions
pycln-2.6.1-py3-none-any.whl Python 3 none any Details for pycln-2.6.1-py3-none-any.whl

Total release size: 71.2 kB

Release files / pycln-2.6.1.tar.gz

Download URL pycln-2.6.1.tar.gz
Size 33.4 kB
Tags Source
SHA-256 checksum
How to use checksums
23e2ce1cba4df31e692c63cf23ee8e126072c55ce027e1c78dd09240aba069ea
BLAKE2b-256 checksum
How to use checksums
eda71d63a8282b52d55ccb40aa4b33f7da4d48227ec625fc1b3b32791210eae2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.13.1 Linux/7.0.0-1017-azure

Release files / pycln-2.6.1-py3-none-any.whl

Download URL pycln-2.6.1-py3-none-any.whl
Size 37.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
eae5e0d663a8c01a904e49d5bed6f1b3a7ec8253c5ff9de5fdfccb614db89fdb
BLAKE2b-256 checksum
How to use checksums
a6104e4423e313c16be2f278cef2768c27cb0fce63f9e5ac72b8b3889bb3260b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.13.1 Linux/7.0.0-1017-azure

Security for pycln 2.6.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.6.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page