========
sort-all
========
Sort ``__all__`` lists alphabetically
Usage
=====
Install the package, e.g. ``pip install sort-all <path-to-file>``
Run the tool: ``sort-all``
Command line options
====================
Options::
usage: sort-all [-h] [--check] [--no-error-on-fix] [filenames ...]
Sort __all__ records alphabetically.
positional arguments:
filenames Files to process
options:
-h, --help show this help message and exit
--check check the file for unsorted / unformatted imports and print them to the command line without modifying the file; return 0
when nothing would change and return 1 when the file would be reformatted.
--no-error-on-fix return 0 even if errors are occurred during processing files
Usage with pre-commit
=====================
sort-all can be used as a hook for pre-commit_.
To add sort-all as a plugin, add this repo definition to your configuration:
.. code-block:: yaml
repos:
- repo: https://github.com/aio-libs/sort-all
rev: ... # select the tag or revision you want, or run `pre-commit autoupdate`
hooks:
- id: sort-all
.. _`pre-commit`: https://pre-commit.com
Raw data
{
"_id": null,
"home_page": "https://github.com/aio-libs/sort-all",
"name": "sort-all",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Andrew Svetlov",
"author_email": "andrew.svetlov@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/40/be/1325e717294bb01a69c9255ba397056b990abb2e03365554b5850a8483b3/sort_all-1.3.0.tar.gz",
"platform": null,
"description": "========\nsort-all\n========\n\nSort ``__all__`` lists alphabetically\n\nUsage\n=====\n\nInstall the package, e.g. ``pip install sort-all <path-to-file>``\n\nRun the tool: ``sort-all``\n\nCommand line options\n====================\n\nOptions::\n\n usage: sort-all [-h] [--check] [--no-error-on-fix] [filenames ...]\n\n Sort __all__ records alphabetically.\n\n positional arguments:\n filenames Files to process\n\n options:\n -h, --help show this help message and exit\n --check check the file for unsorted / unformatted imports and print them to the command line without modifying the file; return 0\n when nothing would change and return 1 when the file would be reformatted.\n --no-error-on-fix return 0 even if errors are occurred during processing files\n\n\nUsage with pre-commit\n=====================\n\n\nsort-all can be used as a hook for pre-commit_.\n\nTo add sort-all as a plugin, add this repo definition to your configuration:\n\n.. code-block:: yaml\n\n repos:\n - repo: https://github.com/aio-libs/sort-all\n rev: ... # select the tag or revision you want, or run `pre-commit autoupdate`\n hooks:\n - id: sort-all\n\n.. _`pre-commit`: https://pre-commit.com\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Automatically Sort __all__ records alphabetically",
"version": "1.3.0",
"project_urls": {
"Homepage": "https://github.com/aio-libs/sort-all"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7c65dc790a4bf84e0b695a9b1d2a217bad7c88fa31d76fa3569b8daec75f2bc2",
"md5": "b85dd18a5cbe17c87c9ee92914f20f1a",
"sha256": "1e452564993c1084a85b0d4600d00e638492d2fd9db7443c38627e9899f8e06a"
},
"downloads": -1,
"filename": "sort_all-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b85dd18a5cbe17c87c9ee92914f20f1a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4711,
"upload_time": "2024-10-30T13:18:37",
"upload_time_iso_8601": "2024-10-30T13:18:37.241067Z",
"url": "https://files.pythonhosted.org/packages/7c/65/dc790a4bf84e0b695a9b1d2a217bad7c88fa31d76fa3569b8daec75f2bc2/sort_all-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "40be1325e717294bb01a69c9255ba397056b990abb2e03365554b5850a8483b3",
"md5": "7b743271880cd46ed68025405588188a",
"sha256": "41fd883a4dcba38fef30e4dfc2c8ecf75dc6f450baa6c8bb2e6d30c7189fc148"
},
"downloads": -1,
"filename": "sort_all-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "7b743271880cd46ed68025405588188a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4946,
"upload_time": "2024-10-30T13:18:38",
"upload_time_iso_8601": "2024-10-30T13:18:38.231507Z",
"url": "https://files.pythonhosted.org/packages/40/be/1325e717294bb01a69c9255ba397056b990abb2e03365554b5850a8483b3/sort_all-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 13:18:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aio-libs",
"github_project": "sort-all",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "sort-all"
}
JSON
