FAQ

Q: Can I tell elpy not to load one of the minor modes it enables by default?

A: You can simply remove the appropriate symbol from elpy-modules.

Q: How do I make Elpy work well with org-mode?

A: You can try the following customization by @mankoff:

(setq python-shell-interpreter "ipython"
      python-shell-interpreter-args "--pylab=osx --pdb --nosep --classic"
      python-shell-prompt-regexp ">>> "
      python-shell-prompt-output-regexp ""
      python-shell-completion-setup-code "from IPython.core.completerlib import module_completion"
      python-shell-completion-module-string-code "';'.join(module_completion('''%s'''))\n"
      python-shell-completion-string-code "';'.join(get_ipython().Completer.all_completions('''%s'''))\n")

See #191 for a discussion and background.

Q: Can I get documentation as pop-ups next to the completion pop-up?

A: Not by default with company-mode, but there’s expez’ excellent company-quickhelp package you can install for this feature. It’s available from MELPA.

Q: How to solve company, yasnippet conflicts?

A: Add this snippet to your emacs configuration to avoid that.

(defun company-yasnippet-or-completion ()
  "Solve company yasnippet conflicts."
  (interactive)
  (let ((yas-fallback-behavior
         (apply 'company-complete-common nil)))
    (yas-expand)))

(add-hook 'company-mode-hook
          (lambda ()
            (substitute-key-definition
             'company-complete-common
             'company-yasnippet-or-completion
             company-active-map)))

Q: Do I have to install all the python packages every time?

A: Installing them all in the same virtualenv is the easiest way to do this. There are a few other options, though. You can install jedi etc. globally (or as a user) and use virtualenvwrapper’s togglesitepackages to include globally installed packages in your virtualenv. Or you can install them in a separate virtualenv and set PYTHONPATH to include that virtualenv.

Q: How do I install development version of elpy?

A: Remove existing elpy if you already installed it.

rm -rf ~/.emacs.d/elpa/elpy*

Install dependencies

(package-install 'company)
(package-install 'yasnippet)
(package-install 'pyvenv)
(package-install 'highlight-indentation)
(package-install 'find-file-in-project)
(package-install 's)

Get latest code from github

mkdir ~/Projects
cd ~/Projects
git clone https://github.com/jorgenschaefer/elpy

Add the following to your ~/.emacs.d/init.el or ~/.emacs:

(add-to-list 'load-path "~/Projects/elpy")
(load "elpy" nil t)
(elpy-enable)

To update, run git pull --rebase, M-x load-library RET elpy RET and M-x elpy-rpc-reload.