README.org 1.38 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
* py-isort.el

[[https://travis-ci.org/paetzke/py-isort.el][https://travis-ci.org/paetzke/py-isort.el.svg?branch=master]]
[[http://melpa.org/#/py-isort][http://melpa.org/packages/py-isort-badge.svg]]

Provides commands, which use the external =isort= tool to tidy up the imports in the current buffer.

Install =isort= and download =py-isort=

#+BEGIN_SRC bash
$ pip install isort
$ wget https://raw.githubusercontent.com/paetzke/py-isort.el/master/py-isort.el \
       -O /your/path/py-isort.el
#+END_SRC

You can also install =py-isort= with /MELPA/:

#+BEGIN_SRC lisp
M-x package-install RET
py-isort RET
#+END_SRC

Add the =before-save-hook= to your =~/.emacs=

#+BEGIN_SRC lisp
(add-to-list 'load-path "/your/path/")
(require 'py-isort)
(add-hook 'before-save-hook 'py-isort-before-save)
#+END_SRC

Now every time you save your Python file =isort= will be executed on the current buffer.

To customize the behaviour of =isort= you can set the =py-isort-options= e.g.

#+BEGIN_SRC lisp
(setq py-isort-options '("--lines=100"))
#+END_SRC


** Functions

- =M-x py-isort-buffer RET=: Uses the =isort= tool to reformat the current buffer.
- =M-x py-isort-region RET=: Uses the =isort= tool to reformat the current region.


** Bugs and improvements

Feel free to open tickets or send pull requests with improvements.
These [[https://github.com/paetzke/py-isort.el/graphs/contributors][contributors]] have done so.