# 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).
Raw data
{
"_id": null,
"home_page": "https://github.com/greenbone/autohooks-plugin-isort",
"name": "autohooks-plugin-isort",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "git,formatting,hooks,isort",
"author": "Greenbone AG",
"author_email": "info@greenbone.net",
"download_url": "https://files.pythonhosted.org/packages/27/30/50517bf8fab0972f6eeb7c8bc9ddb17402e1e00bb39691e560df6eaae529/autohooks_plugin_isort-23.10.0.tar.gz",
"platform": null,
"description": "\n\n# autohooks-plugin-isort\n\n[](https://pypi.org/project/autohooks-plugin-isort/)\n\nAn [autohooks](https://github.com/greenbone/autohooks) plugin for Python code\nformatting via [isort](https://github.com/timothycrosley/isort).\n\n## Installation\n\n### Install using pip\n\nYou can install the latest stable release of autohooks-plugin-isort from the\nPython Package Index using [pip](https://pip.pypa.io/):\n\n python3 -m pip install autohooks-plugin-isort\n\n### Install using poetry\n\nIt is highly encouraged to use [poetry](https://python-poetry.org) for\nmaintaining your project's dependencies. Normally autohooks-plugin-isort is\ninstalled as a development dependency.\n\n poetry add --dev autohooks-plugin-isort\n\n poetry install\n\n## Usage\n\nTo activate the isort autohooks plugin please add the following setting to your\n*pyproject.toml* file.\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.isort\"]\n```\n\nBy default, autohooks plugin isort checks all files with a *.py* ending. If only\nthe imports of files in a sub-directory or files with different endings should\nbe sorted, just add the following setting:\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.isort\"]\n\n[tool.autohooks.plugins.isort]\ninclude = ['foo/*.py', '*.foo']\n```\n\nWhen using `autohooks-plugins-isort` in combination with\n[autohooks-plugin-black](https://github.com/greenbone/autohooks-plugin-black),\nthe following configuration is recommended to ensure a consistent formatting:\n\n```toml\n[tool.isort]\nprofile = \"black\"\n```\n\n## Maintainer\n\nThis project is maintained by [Greenbone AG](https://www.greenbone.net/).\n\n## Contributing\n\nYour contributions are highly appreciated. Please\n[create a pull request](https://github.com/greenbone/autohooks-plugin-isort/pulls)\non GitHub. Bigger changes need to be discussed with the development team via the\n[issues section at GitHub](https://github.com/greenbone/autohooks-plugin-isort/issues)\nfirst.\n\n## License\n\nCopyright (C) 2019 - 2023 [Greenbone AG](https://www.greenbone.net/)\n\nLicensed under the [GNU General Public License v3.0 or later](LICENSE).\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "An autohooks plugin for python code formatting via isort",
"version": "23.10.0",
"project_urls": {
"Homepage": "https://github.com/greenbone/autohooks-plugin-isort",
"Repository": "https://github.com/greenbone/autohooks-plugin-isort"
},
"split_keywords": [
"git",
"formatting",
"hooks",
"isort"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f76c6bc17e860df522eb8361525c6fd0a3916f4bccafbb3a374bee74ecc8f10f",
"md5": "d398abd5e81962aca9435a709bbec959",
"sha256": "40619191a1d21d7ebb59f03ad21e032cadfe56e2e016cf430d37218340727f6c"
},
"downloads": -1,
"filename": "autohooks_plugin_isort-23.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d398abd5e81962aca9435a709bbec959",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 16960,
"upload_time": "2023-10-18T08:45:40",
"upload_time_iso_8601": "2023-10-18T08:45:40.949214Z",
"url": "https://files.pythonhosted.org/packages/f7/6c/6bc17e860df522eb8361525c6fd0a3916f4bccafbb3a374bee74ecc8f10f/autohooks_plugin_isort-23.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "273050517bf8fab0972f6eeb7c8bc9ddb17402e1e00bb39691e560df6eaae529",
"md5": "e091ec7be8d7c6405bac057b490fa9b2",
"sha256": "9548efb7350021bda0f0c6a1ab030e8a76d7a88774cff5ef130423329afe7ce3"
},
"downloads": -1,
"filename": "autohooks_plugin_isort-23.10.0.tar.gz",
"has_sig": false,
"md5_digest": "e091ec7be8d7c6405bac057b490fa9b2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 33195,
"upload_time": "2023-10-18T08:45:42",
"upload_time_iso_8601": "2023-10-18T08:45:42.272969Z",
"url": "https://files.pythonhosted.org/packages/27/30/50517bf8fab0972f6eeb7c8bc9ddb17402e1e00bb39691e560df6eaae529/autohooks_plugin_isort-23.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-18 08:45:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "greenbone",
"github_project": "autohooks-plugin-isort",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "autohooks-plugin-isort"
}
JSON
