Skip to content
This repository has been archived by the owner on Dec 5, 2023. It is now read-only.

Commit

Permalink
Unleash the pretty
Browse files Browse the repository at this point in the history
  • Loading branch information
jmcantrell committed Mar 9, 2011
1 parent 91016ad commit b9aa9d8
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.mkd
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
virtualenv.vim
==============

When using :python or :!python, it will only have access to the environment outside of any virtualenvs. If you're working with packages that are only installed in a virtualenv, they will not be available to Vim.

*__Until now!__* The virtualenv.vim plugin will modify python's sys.path and the $PATH environment variable so that anything done with :python or :!python will behave like you would expect for the chosen virtualenv.

If compiled with python support, Vim will have a :python command, but this will be tied to whatever version is the default on your system. If this is the version of python that you use, or you're using a Linux distribution with a sensible package manager (like Debian or Ubuntu), you likely will not have to do anything more than install the plugin. If not, then you will likely have to recompile vim with your version of python.

Usage examples
==============

Expand All @@ -17,12 +26,16 @@ If you're sure which one to activate, you could always use tab completion

:VirtualEnvActivate <tab>

![tab-completion](http://i.imgur.com/1ZGrM.png "Tab Completion")

If you're a virtualenvwrapper user and have $PROJECT\_HOME set, omitting the
name will try to guess which virtualenv to activate based on the current
filename.

Todo
====
You can even show the current virtualenv in the statusline with the included function

![statusline](http://i.imgur.com/oxE70.png "Statusline")

For more detailed help

* Add/modify $PATH so that it uses the virtualenv first and :!python works as expected
* Add more description of statusline feature and general docs fleshing out
:help virtualenv

0 comments on commit b9aa9d8

Please sign in to comment.