Skip to main content

Check python import order.

Project description

Wheel Status Supported Python versions pypi packages travis-ci status

CLI that check the ordering of imports. ordering follow a below rules.

  1. Module order: __future__ , standard libraries, site-packages, local.
  2. CONSTANT_NAMES must be the first.
  3. ClassNames must be the second.
  4. Rest must be in alphabetical order.

Requirements

  • Python 2.7.x or Python 3.3+

How to install

Via pip

$ pip install -U import-order

Or clone source code from repository and install it.

$ git clone https://github.com/spoqa/import-order.git
$ cd import_order
$ python setup.py install # or pip install .

How to use

Use import-order to check your python codes. If you want to check your local package named foo in root directory of package.

$ import-order foo

If you check your directory bar with local packages ( foo , baz ).

$ import-order foo ./bar baz

Or you can check your directory bar , file some.py without local packages (if --only-file is missing, it will raise ValueError ).

$ import-order --only-file ./bar some.py

For more information, look around help command.

$ import-order --help

When you ignore order on purpose, simply add # no import order at the import statement.

from foo.bar import b, a, c  # no import order

Author and license

import-order is maintained by Spoqa, and licensed under GPL3 or later.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for import-order, version 0.0.11
Filename, size File type Python version Upload date Hashes
Filename, size import_order-0.0.11-py2.py3-none-any.whl (11.2 kB) File type Wheel Python version 3.5 Upload date Hashes View
Filename, size import-order-0.0.11.tar.gz (6.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page