dhellmann / virtualenvwrapper (http://doughellmann.com/projects/virtualenvwrapper/)

Extensions to Ian Bicking's virtualenv tool. Downloads are available from http://www.doughellmann.com/projects/virtualenv... or you can install with easy_install.

 NB: This is not the latest revision. For the latest view, go to tip.

View at rev
virtualenvwrapper /
filename size last modified message
.hgignore 76 B 12 months ago add more hooks based on suggestion from Chris Hasenpflug; ad…
.hgtags 730 B 12 months ago Added tag 1.9 for changeset d8112e52eadc
MANIFEST.in 82 B 13 months ago convert from make to paver 1.0
README 5.9 KB 12 months ago update change history
TODO 96 B 12 months ago Clean up TODO list and svn keywords. Add license section to…
pavement.py 2.9 KB 12 months ago update change history
test.sh 916 B 12 months ago add more hooks based on suggestion from Chris Hasenpflug; ad…
virtualenvwrapper_bashrc 5.8 KB 12 months ago Updated 'workon' to use find, to avoid problems with…

README

 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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

#################
virtualenvwrapper
#################

virtualenvwrapper is a set of extensions to Ian Bicking's `virtualenv
<http://pypi.python.org/pypi/virtualenv>`_ tool.  The extensions include
wrappers for creating and deleting virtual environments and otherwise
managing your development workflow, making it easier to work on more
than one project at a time without introducing conflicts in their
dependencies.

========
Features
========

1.  Organizes all of your virtual environments in one place.

2.  Wrappers for creating and deleting environments, including
    user-configurable hooks.

3.  Use a single command to switch between environments.

4.  Tab completion for commands that take a virtual environment as
    argument.

Rich Leland has created a short `screencast
<http://mathematism.com/2009/jul/30/presentation-pip-and-virtualenv/>`__
showing off the features of virtualenvwrapper.

===========
Quick Setup
===========

1. Create a directory to hold all of the virtual environments. The default is
   ``$HOME/.virtualenvs``.

2. Add two lines to your .bashrc to set the location where the virtual environments should
   live and the location of the script installed with this package::

    export WORKON_HOME=$HOME/.virtualenvs
    source /usr/local/bin/virtualenvwrapper_bashrc

3. Run: ``source ~/.bashrc``
4. Run: ``workon``
5. A list of environments, empty, is printed.
6. Run: ``mkvirtualenv temp``
7. A new environment, ``temp`` is created and activated.
8. Run: ``workon``
9. This time, the ``temp`` environment is included.

=======
License
=======

Copyright Doug Hellmann, All Rights Reserved

Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in
supporting documentation, and that the name of Doug Hellmann not be used
in advertising or publicity pertaining to distribution of the software
without specific, written prior permission.

DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.