============================================
 Jedi.el - Python auto-completion for Emacs
============================================

.. sidebar:: Links:

   * `Documentation (dev) <http://tkf.github.io/emacs-jedi/latest>`_
     (`released version <http://tkf.github.io/emacs-jedi/released>`_)

     * `Screenshots <http://tkf.github.io/emacs-jedi/latest#screenshots>`_
     * `Configuration <http://tkf.github.io/emacs-jedi/latest#configuration>`_
     * `Command <http://tkf.github.io/emacs-jedi/latest#command>`_
     * `FAQ <http://tkf.github.io/emacs-jedi/latest#faq>`_
     * `Troubleshooting <http://tkf.github.io/emacs-jedi/latest#troubleshooting>`_
     * `Complete overview <http://tkf.github.io/emacs-jedi/latest/contents.html>`_
     * `Changelog <http://tkf.github.io/emacs-jedi/latest/changelog.html>`_

   * `Q & A in StackOverflow
     <http://stackoverflow.com/questions/tagged/emacs-jedi>`_
     (with ``emacs-jedi`` tag)
   * `Repository <https://github.com/tkf/emacs-jedi>`_ (at GitHub)
   * `Issue tracker <https://github.com/tkf/emacs-jedi/issues>`_ (at GitHub)
   * `Travis CI <https://travis-ci.org/tkf/emacs-jedi>`_ |build-status|
   * `MELPA <https://melpa.org/#/jedi-jedi>`_ |melpa-badge|
   * `MELPA Stable <https://stable.melpa.org/#/jedi>`_ |melpa-stable-badge|


What is it?
===========

Jedi.el is a Python auto-completion package for Emacs.
It aims at helping your Python coding in a non-destructive way.
It also helps you to find information about Python objects, such as
docstring, function arguments and code location.

For more info, read documentation.
If you are using developmental version installed via el-get or MELPA, read
the `developmental version <http://tkf.github.io/emacs-jedi/latest>`_.
If you are using released version installed via Marmalade, read
the `released version <http://tkf.github.io/emacs-jedi/released>`_.


.. figure:: http://farm9.staticflickr.com/8261/8804536872_8d266b88ed_o.png

   Auto-completion using Jedi.el.
   See more screenshots
   `here <http://tkf.github.io/emacs-jedi/latest#screenshots>`_.

Company Users
=============

**NOTE: Please do not install 'jedi' package for company users. You should install only company-jedi.**

If you use `company <https://github.com/company-mode/company-mode>`_,
please see `company-jedi <https://github.com/syohex/emacs-company-jedi>`_.


.. Build status badge
.. |build-status|
   image:: https://secure.travis-ci.org/tkf/emacs-jedi.png?branch=master
   :target: http://travis-ci.org/tkf/emacs-jedi
   :alt: Build Status
.. |melpa-badge|
   image:: http://melpa.org/packages/jedi-badge.svg
   :target: http://melpa.org/#/jedi
   :alt: MELPA Badge
.. |melpa-stable-badge|
   image:: http://stable.melpa.org/packages/jedi-badge.svg
   :target: http://stable.melpa.org/#/jedi
   :alt: MELPA Stable Badge
