Read the documentation on Github pages!
Pycln requires Python 3.6+ 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
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:
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:
The following notable open-source projects trust and use Pycln:
The following organizations use Pycln:
Are we missing anyone? Let us know.
MIT
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:
The log has become rather long. It moved to its own file.
See CHANGELOG.
The author list is quite long nowadays, so it lives in its own file.
See AUTHORS
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!
FAQs
A formatter for finding and removing unused import statements.
We found that pycln demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.