|
2 | 2 | virtualenvwrapper
|
3 | 3 | #################
|
4 | 4 |
|
5 |
| -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. |
| 5 | +virtualenvwrapper is a set of extensions to Ian Bicking's `virtualenv |
| 6 | +<http://pypi.python.org/pypi/virtualenv>`_ tool. The extensions include |
| 7 | +wrappers for creating and deleting virtual environments and otherwise |
| 8 | +managing your development workflow, making it easier to work on more |
| 9 | +than one project at a time without introducing conflicts in their |
| 10 | +dependencies. |
6 | 11 |
|
7 | 12 | ========
|
8 | 13 | Features
|
9 | 14 | ========
|
10 | 15 |
|
11 |
| - 1. Organizes all of your virtual environments in one place. |
12 |
| - 2. Wrappers for creating and deleting environments, including user-configurable hooks. |
13 |
| - 3. Use a single command to switch between environments. |
14 |
| - 4. Tab completion for commands that take a virtual environment as argument. |
| 16 | +1. Organizes all of your virtual environments in one place. |
| 17 | + |
| 18 | +2. Wrappers for creating and deleting environments, including |
| 19 | + user-configurable hooks. |
| 20 | + |
| 21 | +3. Use a single command to switch between environments. |
| 22 | + |
| 23 | +4. Tab completion for commands that take a virtual environment as |
| 24 | + argument. |
15 | 25 |
|
16 | 26 | ===========
|
17 | 27 | Quick Setup
|
18 | 28 | ===========
|
19 | 29 |
|
20 |
| -1. 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:: |
| 30 | +1. Add two lines to your .bashrc to set the location where the virtual |
| 31 | + environments should live and the location of the script installed |
| 32 | + with this package:: |
21 | 33 |
|
22 |
| - export WORKON_HOME=$HOME/.virtualenvs |
23 |
| - source /usr/local/bin/virtualenvwrapper_bashrc |
| 34 | + export WORKON_HOME=$HOME/.virtualenvs |
| 35 | + source /usr/local/bin/virtualenvwrapper_bashrc |
24 | 36 |
|
25 |
| -2. Run: ``source ~/.bashrc`` |
26 |
| -3. Run: ``workon`` |
27 |
| -4. A list of environments, empty, is printed. |
28 |
| -5. Run: ``mkvirtualenv temp`` |
29 |
| -6. A new environment, ``temp`` is created and activated. |
30 |
| -7. Run: ``workon`` |
31 |
| -8. This time, the ``temp`` environment is included. |
| 37 | +2. Run: ``source ~/.bashrc`` |
| 38 | +3. Run: ``workon`` |
| 39 | +4. A list of environments, empty, is printed. |
| 40 | +5. Run: ``mkvirtualenv temp`` |
| 41 | +6. A new environment, ``temp`` is created and activated. |
| 42 | +7. Run: ``workon`` |
| 43 | +8. This time, the ``temp`` environment is included. |
32 | 44 |
|
33 | 45 | =======
|
34 | 46 | License
|
35 | 47 | =======
|
36 | 48 |
|
37 | 49 | Copyright Doug Hellmann, All Rights Reserved
|
38 | 50 |
|
39 |
| -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. |
| 51 | +Permission to use, copy, modify, and distribute this software and its |
| 52 | +documentation for any purpose and without fee is hereby granted, |
| 53 | +provided that the above copyright notice appear in all copies and that |
| 54 | +both that copyright notice and this permission notice appear in |
| 55 | +supporting documentation, and that the name of Doug Hellmann not be used |
| 56 | +in advertising or publicity pertaining to distribution of the software |
| 57 | +without specific, written prior permission. |
40 | 58 |
|
41 |
| -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. |
| 59 | +DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, |
| 60 | +INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO |
| 61 | +EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR |
| 62 | +CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF |
| 63 | +USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR |
| 64 | +OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
| 65 | +PERFORMANCE OF THIS SOFTWARE. |
0 commit comments