Metadata-Version: 2.4
Name: usort
Version: 1.1.0
Summary: Safe, minimal import sorting
Project-URL: Changelog, https://usort.readthedocs.io/en/latest/changelog.html
Project-URL: Documentation, https://usort.readthedocs.io
Project-URL: Github, https://github.com/facebook/usort
Author: Meta
Author-email: Tim Hatch <thatch@fb.com>, Amethyst Reese <amethyst@fb.com>
License: MIT License
        
        Copyright (c) Meta Platforms, Inc. and affiliates.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: imports,isort,usort
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: attrs>=21.2.0
Requires-Dist: click>=7.0.0
Requires-Dist: libcst>=0.3.7
Requires-Dist: moreorless>=0.3.0
Requires-Dist: stdlibs>=2021.4.1
Requires-Dist: toml>=0.10.0
Requires-Dist: trailrunner<2.0,>=1.0
Provides-Extra: dev
Requires-Dist: black==25.9.0; extra == 'dev'
Requires-Dist: click==8.1.8; extra == 'dev'
Requires-Dist: coverage==7.11.0; extra == 'dev'
Requires-Dist: flake8==7.3.0; extra == 'dev'
Requires-Dist: hatch==1.15.1; extra == 'dev'
Requires-Dist: mypy==1.18.2; extra == 'dev'
Requires-Dist: pessimist==0.9.3; extra == 'dev'
Requires-Dist: ufmt==2.8.0; extra == 'dev'
Requires-Dist: volatile==2.1.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx-mdinclude==0.6.2; extra == 'docs'
Requires-Dist: sphinx==7.4.7; extra == 'docs'
Description-Content-Type: text/markdown

# μsort

**Safe, minimal import sorting for Python projects.**

[![documentation](https://readthedocs.org/projects/usort/badge/?version=stable)](https://usort.readthedocs.io/en/stable/?badge=stable)
[![version](https://img.shields.io/pypi/v/usort.svg)](https://pypi.org/project/usort)
[![changelog](https://img.shields.io/badge/change-log-blue.svg)](https://usort.readthedocs.io/en/latest/changelog.html)
[![license](https://img.shields.io/pypi/l/usort.svg)](https://github.com/facebook/usort/blob/main/LICENSE)

μsort is a safe, minimal import sorter. Its primary goal is to make no "dangerous"
changes to code. This is achieved by detecting distinct "blocks" of imports that are
the most likely to be safely interchangeable, and only reordering imports within these
blocks without altering formatting. Code style is left as an exercise for linters
and formatters.

Within a block, µsort will follow common Python conventions for grouping imports based
on source (standard library, third-party, first-party, or relative), and then sorting
lexicographically within each group. This will commonly look like:

```py
import re
from pathlib import Path
from typing import Iterable
from unittest.mock import call, Mock, patch

import aiohttp
from aiosqlite import connect

import foo
from bar import bar

from .main import main
```

Blocks are inferred from a number of real world conditions, including any intermediate
statements between imports:

```py
import warnings
warnings.filterwarnings(...)

import re
import sys
```

In this case, µsort detects two blocks–separated by the call to `filterwarnings()`,
and will only sort imports inside of each block. Running µsort on this code
will generate no changes, because each block is already sorted.

Imports can be excluded from blocks using the `#usort:skip` directive, or with
`#isort:skip` for compatibility with existing codebases. µsort will leave
these imports unchanged, and treat them as block separators.

See the [User Guide][] for more details about how blocks are detected,
and how sorting is performed.


## Install

µsort requires Python 3.10 or newer to run. Install µsort with:

```shell-session
$ pip install usort
```


## Usage

To format one or more files or directories in-place:

```shell-session
$ usort format <path> [<path> ...]
```

To generate a diff of changes without modifying files:

```shell-session
$ usort diff <path>
```

To just validate that files are formatted correctly, like during CI:

```shell-session
$ usort check <path>
```

### pre-commit

µsort provides a [pre-commit](https://pre-commit.com/) hook. To enforce sorted
imports before every commit, add the following to your `.pre-commit-config.yaml`
file:

```yaml
- repo: https://github.com/facebook/usort
  rev: v1.0.7
  hooks:
    - id: usort
```

## License

μsort is MIT licensed, as found in the [LICENSE][] file.

[LICENSE]: https://github.com/facebook/usort/tree/main/LICENSE
[User Guide]: https://usort.readthedocs.io/en/stable/guide.html
