update elpy
[emacs.git] / .emacs.d / elisp / elpy / README
1 =======================================
2 Elpy, the Emacs Lisp Python Environment
3 =======================================
4
5 Elpy is an Emacs package to bring powerful Python editing to Emacs. It
6 combines a number of other packages, both written in Emacs Lisp as
7 well as Python.
8
9 .. image:: https://secure.travis-ci.org/jorgenschaefer/elpy.png
10 :alt: Build Status
11 :target: http://travis-ci.org/jorgenschaefer/elpy
12 :width: 77px
13 :height: 19px
14
15 Documentation
16 =============
17
18 You can find the documentation `on the wiki`__.
19
20 .. __: https://github.com/jorgenschaefer/elpy/wiki
21
22 Quick Installation
23 ==================
24
25 You can also read the `detailed installation instructions`__.
26
27 .. __: https://github.com/jorgenschaefer/elpy/wiki/Installation
28
29 First, install the required Python packages:::
30
31 pip install elpy rope
32
33 (Note: If you are installing the development version of elpy, do not
34 install the elpy Python package, but simply put the repository in your
35 ``PYTHONPATH``.)
36
37 Evaluate this in your ``*scratch*`` buffer:
38
39 .. code-block:: lisp
40
41 (require 'package)
42 (add-to-list 'package-archives
43 '("elpy" . "http://jorgenschaefer.github.io/packages/"))
44
45
46 Then run ``M-x package-refresh-contents`` to load the contents of the
47 new repository, and ``M-x package-install RET elpy RET`` to install
48 elpy.
49
50 Finally, add the following to your ``.emacs``:
51
52 .. code-block:: lisp
53
54 (package-initialize)
55 (elpy-enable)
56
57 Done.