autohooks-plugin-isort

An autohooks plugin for Python code formatting via isort.

Installation

Install using pip

You can install the latest stable release of autohooks-plugin-isort from the Python Package Index using pip:

pip install autohooks-plugin-isort

Note the pip refers to the Python 3 package manager. In a environment where Python 2 is also available the correct command may be pip3.

Install using poetry

It is highly encouraged to use poetry for maintaining your project's dependencies. Normally autohooks-plugin-isort is installed as a development dependency.

poetry install

Usage

To activate the isort autohooks plugin please add the following setting to your pyproject.toml file.

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

[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, the following configuration is recommended to ensure a consistent formatting:

[tool.isort]
multi_line_output = 3
include_trailing_comma = true
force_grid_wrap = 0
use_parentheses = true
line_length = 80

Maintainer

This project is maintained by Greenbone Networks GmbH.

Contributing

Your contributions are highly appreciated. Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at GitHub first.

License

Copyright (C) 2019 Greenbone Networks GmbH

Licensed under the GNU General Public License v3.0 or later.