Metadata-Version: 2.1
Name: isort
Version: 5.9.3
Summary: A Python utility / library to sort Python imports.
Home-page: UNKNOWN
Author: Timothy Crosley
Author-email: timothy.crosley@gmail.com
License: MIT
Project-URL: documentation, https://pycqa.github.io/isort/
Project-URL: homepage, https://pycqa.github.io/isort/
Project-URL: repository, https://github.com/pycqa/isort
Keywords: Refactor Lint Imports Sort Clean
Platform: UNKNOWN
Classifier: Development Status :: 6 - Mature
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Python: <4.0,>=3.6.1
Provides-Extra: colors
Provides-Extra: dev
Provides-Extra: pipfile_deprecated_finder
Provides-Extra: plugins
Provides-Extra: requirements_deprecated_finder
License-File: LICENSE



.. image:: https://raw.githubusercontent.com/pycqa/isort/main/art/logo_large.png
   :target: https://pycqa.github.io/isort/
   :alt: isort - isort your imports, so you don't have to.


----


.. image:: https://badge.fury.io/py/isort.svg
   :target: https://badge.fury.io/py/isort
   :alt: PyPI version


.. image:: https://github.com/pycqa/isort/workflows/Test/badge.svg?branch=develop
   :target: https://github.com/pycqa/isort/actions?query=workflow%3ATest
   :alt: Test Status


.. image:: https://github.com/pycqa/isort/workflows/Lint/badge.svg?branch=develop
   :target: https://github.com/pycqa/isort/actions?query=workflow%3ALint
   :alt: Lint Status


.. image:: https://codecov.io/gh/pycqa/isort/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/pycqa/isort
   :alt: Code coverage Status


.. image:: https://img.shields.io/github/license/mashape/apistatus.svg
   :target: https://pypi.org/project/isort/
   :alt: License


.. image:: https://badges.gitter.im/Join%20Chat.svg
   :target: https://gitter.im/timothycrosley/isort?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
   :alt: Join the chat at https://gitter.im/timothycrosley/isort


.. image:: https://pepy.tech/badge/isort
   :target: https://pepy.tech/project/isort
   :alt: Downloads


.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Code style: black


.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
   :target: https://pycqa.github.io/isort/
   :alt: Imports: isort


.. image:: https://static.deepsource.io/deepsource-badge-light-mini.svg
   :target: https://deepsource.io/gh/pycqa/isort/?ref=repository-badge
   :alt: DeepSource


----

`Read Latest Documentation <https://pycqa.github.io/isort/>`_ - `Browse GitHub Code Repository <https://github.com/pycqa/isort/>`_

----

isort your imports, so you don't have to.

isort is a Python utility / library to sort imports alphabetically, and
automatically separated into sections and by type. It provides a command line
utility, Python library and `plugins for various
editors <https://github.com/pycqa/isort/wiki/isort-Plugins>`_ to
quickly sort all your imports. It requires Python 3.6+ to run but
supports formatting Python 2 code too.


* `Try isort now from your browser! <https://pycqa.github.io/isort/docs/quick_start/0.-try.html>`_
* `Using black? See the isort and black compatibility guide. <https://pycqa.github.io/isort/docs/configuration/black_compatibility.html>`_
* `isort has official support for pre-commit! <https://pycqa.github.io/isort/docs/configuration/pre-commit.html>`_


.. image:: https://raw.github.com/pycqa/isort/main/example.gif
   :target: https://raw.github.com/pycqa/isort/main/example.gif
   :alt: Example Usage


Before isort:

.. code-block:: python

   from my_lib import Object

   import os

   from my_lib import Object3

   from my_lib import Object2

   import sys

   from third_party import lib15, lib1, lib2, lib3, lib4, lib5, lib6, lib7, lib8, lib9, lib10, lib11, lib12, lib13, lib14

   import sys

   from __future__ import absolute_import

   from third_party import lib3

   print("Hey")
   print("yo")

After isort:

.. code-block:: python

   from __future__ import absolute_import

   import os
   import sys

   from third_party import (lib1, lib2, lib3, lib4, lib5, lib6, lib7, lib8,
                            lib9, lib10, lib11, lib12, lib13, lib14, lib15)

   from my_lib import Object, Object2, Object3

   print("Hey")
   print("yo")

Installing isort
----------------

Installing isort is as simple as:

.. code-block:: bash

   pip install isort

Install isort with requirements.txt support:

.. code-block:: bash

   pip install isort[requirements_deprecated_finder]

Install isort with Pipfile support:

.. code-block:: bash

   pip install isort[pipfile_deprecated_finder]

Install isort with both formats support:

.. code-block:: bash

   pip install isort[requirements_deprecated_finder,pipfile_deprecated_finder]

Using isort
-----------

**From the command line**\ :

To run on specific files:

.. code-block:: bash

   isort mypythonfile.py mypythonfile2.py

To apply recursively:

.. code-block:: bash

   isort .

If `globstar <https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html>`_
is enabled, ``isort .`` is equivalent to:

.. code-block:: bash

   isort **/*.py

To view proposed changes without applying them:

.. code-block:: bash

   isort mypythonfile.py --diff

Finally, to atomically run isort against a project, only applying
changes if they don't introduce syntax errors:

.. code-block:: bash

   isort --atomic .

(Note: this is disabled by default, as it prevents isort from
running against code written using a different version of Python.)

**From within Python**\ :

.. code-block:: python

   import isort

   isort.file("pythonfile.py")

or:

.. code-block:: python

   import isort

   sorted_code = isort.code("import b\nimport a\n")

Installing isort's for your preferred text editor
-------------------------------------------------

Several plugins have been written that enable to use isort from within a
variety of text-editors. You can find a full list of them `on the isort
wiki <https://github.com/pycqa/isort/wiki/isort-Plugins>`_.
Additionally, I will enthusiastically accept pull requests that include
plugins for other text editors and add documentation for them as I am
notified.

Multi line output modes
-----------------------

You will notice above the \"multi_line_output\" setting. This setting
defines how from imports wrap when they extend past the line_length
limit and has `12 possible settings <https://pycqa.github.io/isort/docs/configuration/multi_line_output_modes.html>`_.

Indentation
-----------

To change the how constant indents appear - simply change the
indent property with the following accepted formats:


* Number of spaces you would like. For example: 4 would cause standard
  4 space indentation.
* Tab
* A verbatim string with quotes around it.

For example:

.. code-block:: python

   "    "

is equivalent to 4.

For the import styles that use parentheses, you can control whether or
not to include a trailing comma after the last import with the
``include_trailing_comma`` option (defaults to ``False``\ ).

Intelligently Balanced Multi-line Imports
-----------------------------------------

As of isort 3.1.0 support for balanced multi-line imports has been
added. With this enabled isort will dynamically change the import length
to the one that produces the most balanced grid, while staying below the
maximum import length defined.

Example:

.. code-block:: python

   from __future__ import (absolute_import, division,
                           print_function, unicode_literals)

Will be produced instead of:

.. code-block:: python

   from __future__ import (absolute_import, division, print_function,
                           unicode_literals)

To enable this set ``balanced_wrapping`` to ``True`` in your config or pass
the ``-e`` option into the command line utility.

Custom Sections and Ordering
----------------------------

isort provides configuration options to change almost every aspect of how
imports are organized, ordered, or grouped together in sections.

`Click here <https://pycqa.github.io/isort/docs/configuration/custom_sections_and_ordering.html>`_ for an overview of all these options.

Skip processing of imports (outside of configuration)
-----------------------------------------------------

To make isort ignore a single import simply add a comment at the end of
the import line containing the text ``isort:skip``\ :

.. code-block:: python

   import module  # isort:skip

or:

.. code-block:: python

   from xyz import (abc,  # isort:skip
                    yo,
                    hey)

To make isort skip an entire file simply add ``isort:skip_file`` to the
module's doc string:

.. code-block:: python

   """ my_module.py
       Best module ever

      isort:skip_file
   """

   import b
   import a

Adding or removing an import from multiple files
------------------------------------------------

isort can be ran or configured to add / remove imports automatically.

`See a complete guide here. <https://pycqa.github.io/isort/docs/configuration/add_or_remove_imports.html>`_

Using isort to verify code
--------------------------

The ``--check-only`` option
-------------------------------

isort can also be used to verify that code is correctly formatted
by running it with ``-c``. Any files that contain incorrectly sorted
and/or formatted imports will be outputted to ``stderr``.

.. code-block:: bash

   isort **/*.py -c -v

   SUCCESS: /home/timothy/Projects/Open_Source/isort/isort_kate_plugin.py Everything Looks Good!
   ERROR: /home/timothy/Projects/Open_Source/isort/isort/isort.py Imports are incorrectly sorted.

One great place this can be used is with a pre-commit git hook, such as
this one by \@acdha:

https://gist.github.com/acdha/8717683

This can help to ensure a certain level of code quality throughout a
project.

Git hook
--------

isort provides a hook function that can be integrated into your Git
pre-commit script to check Python code before committing.

`More info here. <https://pycqa.github.io/isort/docs/configuration/git_hook.html>`_

Setuptools integration
----------------------

Upon installation, isort enables a ``setuptools`` command that checks
Python files declared by your project.

`More info here. <https://pycqa.github.io/isort/docs/configuration/setuptools_integration.html>`_

Spread the word
---------------


.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
   :target: https://pycqa.github.io/isort/
   :alt: Imports: isort


Place this badge at the top of your repository to let others know your project uses isort.

For README.md:

.. code-block:: markdown

   [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

Or README.rst:

.. code-block:: rst

   .. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
       :target: https://pycqa.github.io/isort/

Security contact information
----------------------------

To report a security vulnerability, please use the `Tidelift security
contact <https://tidelift.com/security>`_. Tidelift will coordinate the
fix and disclosure.

Why isort?
----------

isort simply stands for import sort. It was originally called
"sortImports" however I got tired of typing the extra characters and
came to the realization camelCase is not pythonic.

I wrote isort because in an organization I used to work in the manager
came in one day and decided all code must have alphabetically sorted
imports. The code base was huge - and he meant for us to do it by hand.
However, being a programmer - I\'m too lazy to spend 8 hours mindlessly
performing a function, but not too lazy to spend 16 hours automating it.
I was given permission to open source sortImports and here we are :)

----

`Get professionally supported isort with the Tidelift
Subscription <https://tidelift.com/subscription/pkg/pypi-isort?utm_source=pypi-isort&utm_medium=referral&utm_campaign=readme>`_

Professional support for isort is available as part of the `Tidelift
Subscription <https://tidelift.com/subscription/pkg/pypi-isort?utm_source=pypi-isort&utm_medium=referral&utm_campaign=readme>`_.
Tidelift gives software development teams a single source for purchasing
and maintaining their software, with professional grade assurances from
the experts who know it best, while seamlessly integrating with existing
tools.

----

Thanks and I hope you find isort useful!

~Timothy Crosley


