https://github.com/greenbone/autohooks-plugin-isort
An autohooks plugin for Python include sorting with isort
https://github.com/greenbone/autohooks-plugin-isort
automation base devops python
Last synced: 6 months ago
JSON representation
An autohooks plugin for Python include sorting with isort
- Host: GitHub
- URL: https://github.com/greenbone/autohooks-plugin-isort
- Owner: greenbone
- License: gpl-3.0
- Created: 2019-08-26T07:26:53.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-07-15T07:41:08.000Z (7 months ago)
- Last Synced: 2025-07-15T17:20:29.323Z (7 months ago)
- Topics: automation, base, devops, python
- Language: Python
- Homepage:
- Size: 893 KB
- Stars: 3
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# autohooks-plugin-isort
[](https://pypi.org/project/autohooks-plugin-isort/)
An [autohooks](https://github.com/greenbone/autohooks) plugin for Python code
formatting via [isort](https://github.com/timothycrosley/isort).
## Installation
### Install using pip
You can install the latest stable release of autohooks-plugin-isort from the
Python Package Index using [pip](https://pip.pypa.io/):
python3 -m pip install autohooks-plugin-isort
### Install using poetry
It is highly encouraged to use [poetry](https://python-poetry.org) for
maintaining your project's dependencies. Normally autohooks-plugin-isort is
installed as a development dependency.
poetry add --dev autohooks-plugin-isort
poetry install
## Usage
To activate the isort autohooks plugin please add the following setting to your
*pyproject.toml* file.
```toml
[tool.autohooks]
pre-commit = ["autohooks.plugins.isort"]
```
By default, autohooks plugin isort checks all files with a *.py* ending. If only
the imports of files in a sub-directory or files with different endings should
be sorted, just add the following setting:
```toml
[tool.autohooks]
pre-commit = ["autohooks.plugins.isort"]
[tool.autohooks.plugins.isort]
include = ['foo/*.py', '*.foo']
```
When using `autohooks-plugins-isort` in combination with
[autohooks-plugin-black](https://github.com/greenbone/autohooks-plugin-black),
the following configuration is recommended to ensure a consistent formatting:
```toml
[tool.isort]
profile = "black"
```
## Maintainer
This project is maintained by [Greenbone AG](https://www.greenbone.net/).
## Contributing
Your contributions are highly appreciated. Please
[create a pull request](https://github.com/greenbone/autohooks-plugin-isort/pulls)
on GitHub. Bigger changes need to be discussed with the development team via the
[issues section at GitHub](https://github.com/greenbone/autohooks-plugin-isort/issues)
first.
## License
Copyright (C) 2019 - 2023 [Greenbone AG](https://www.greenbone.net/)
Licensed under the [GNU General Public License v3.0 or later](LICENSE).