https://github.com/hadialqattan/pycln

A formatter for finding and removing unused import statements.
https://github.com/hadialqattan/pycln

cli-app cross-platform formatters linters pycln pypi-package python3 quality-assurance unused-imports

Last synced: 3 months ago
JSON representation

A formatter for finding and removing unused import statements.

• Host: GitHub
• URL: https://github.com/hadialqattan/pycln
• Owner: hadialqattan
• License: mit
• Created: 2020-08-14T08:29:35.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-01T18:27:10.000Z (9 months ago)
• Last Synced: 2024-07-19T00:15:18.901Z (4 months ago)
• Topics: cli-app, cross-platform, formatters, linters, pycln, pypi-package, python3, quality-assurance, unused-imports
• Language: Python
• Homepage: https://hadialqattan.github.io/pycln
• Size: 1.38 MB
• Stars: 291
• Watchers: 4
• Forks: 19
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: docs/CODE_OF_CONDUCT.md
  • Security: docs/SECURITY.md

Awesome Lists containing this project

• awesome-python-code-formatters - pycln

README

        




    A formatter for finding and removing unused import statements.





    

    

    

    

    

    

    





    

    

    

    





    

    

    

    

    

    

    





    

    

    



---

**[Read the documentation on Github pages!](https://hadialqattan.github.io/pycln)**

---

## Installation and usage

### Installation

Pycln requires Python 3.7+ and can be easily installed using the most common Python

packaging tools. We recommend installing the latest stable release from PyPI with pip:

```bash

$ pip install pycln

```

### Usage

By **default** Pycln will remove any unused import statement, So the simplest usage is

to specify the path only:

```bash

$ pycln [PATH]

```

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

```bash

$ python3 -m pycln [PATH]

```

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

[-a/--all flag](https://hadialqattan.github.io/pycln/#/?id=-a-all-flag).

Further information can be found in our docs:

- [Usage and Configuration](https://hadialqattan.github.io/pycln/#/?id=usage)

## 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:

- [--config [PATH] CLI option](https://hadialqattan.github.io/pycln/#/?id=-config-path-option)

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

- [Usage and Configuration](https://hadialqattan.github.io/pycln/#/?id=usage)

## Used by

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

- [cibuildwheel](https://github.com/pypa/cibuildwheel)

- [Open Event Server](https://github.com/fossasia/open-event-server)

- [pybind11](https://github.com/pybind/pybind11)

- [pywin32](https://github.com/mhammond/pywin32)

- [Poetry](https://github.com/python-poetry/poetry)

- [Pyodide](https://github.com/pyodide/pyodide)

- [Rich](https://github.com/Textualize/rich)

- [typeshed](https://github.com/python/typeshed)

The following organizations use _Pycln_:

- [FOSSASIA](https://github.com/fossasia)

- [Poetry](https://github.com/python-poetry)

- [Python Packaging Authority](https://github.com/pypa)

- [Scikit-HEP](https://github.com/scikit-hep)

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:

- [General guidlines](https://hadialqattan.github.io/pycln/#/CONTRIBUTING?id=general-guidelines)

You can also dive directly into the technicalities:

- [Contributing technicalities](https://hadialqattan.github.io/pycln/#/CONTRIBUTING?id=technicalities)

## Change log

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

See [CHANGELOG](https://hadialqattan.github.io/pycln/#/CHANGELOG).

## Authors

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

See [AUTHORS](https://hadialqattan.github.io/pycln/#/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!