Skip to content

Commit 8843454

Browse files
committed
rename wrapper script
--HG-- rename : virtualenvwrapper_bashrc => virtualenvwrapper.sh
1 parent 281bcff commit 8843454

14 files changed

+45
-21
lines changed

README.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,13 @@ Quick Setup
3434
1. Create a directory to hold all of the virtual environments. The default is
3535
``$HOME/.virtualenvs``.
3636

37-
2. Add two lines to your .bashrc to set the location where the virtual environments should
38-
live and the location of the script installed with this package::
37+
2. Add two lines to your shell startup script (``.bashrc``,
38+
``.bash_profile``, etc.) to set the location where the virtual
39+
environments should live and the location of the script installed
40+
with this package::
3941

4042
export WORKON_HOME=$HOME/.virtualenvs
41-
source /usr/local/bin/virtualenvwrapper_bashrc
43+
source /usr/local/bin/virtualenvwrapper.sh
4244

4345
3. Run: ``source ~/.bashrc``
4446
4. Run: ``workon``
@@ -48,6 +50,15 @@ Quick Setup
4850
8. Run: ``workon``
4951
9. This time, the ``temp`` environment is included.
5052

53+
Upgrading from 1.x
54+
==================
55+
56+
The shell script containing the wrapper functions has been renamed in
57+
the 2.x series to reflect the fact that shells other than bash are
58+
supported. In your startup file, change ``source
59+
/usr/local/bin/virtualenvwrapper_bashrc`` to ``source
60+
/usr/local/bin/virtualenvwrapper.sh``.
61+
5162
=======
5263
License
5364
=======

docs/source/index.rst

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,13 @@ their dependencies.
1818
Features
1919
========
2020

21-
1. Organizes all of your virtual environments in one place.
22-
2. Wrappers for creating and deleting environments, including user-configurable hooks.
23-
3. Use a single command to switch between environments.
24-
4. Tab completion for commands that take a virtual environment as argument.
21+
1. Organizes all of your virtual environments in one place.
22+
2. Wrappers for managing your virtual environments (create, delete,
23+
copy).
24+
3. Use a single command to switch between environments.
25+
4. Tab completion for commands that take a virtual environment as
26+
argument.
27+
5. User-configurable hooks for all operations.
2528

2629
===========
2730
Quick Setup
@@ -34,7 +37,7 @@ Quick Setup
3437
live and the location of the script installed with this package::
3538

3639
export WORKON_HOME=$HOME/.virtualenvs
37-
source /usr/local/bin/virtualenvwrapper_bashrc
40+
source /usr/local/bin/virtualenvwrapper.sh
3841

3942
3. Run: ``source ~/.bashrc``
4043
4. Run: ``workon``
@@ -44,6 +47,15 @@ Quick Setup
4447
8. Run: ``workon``
4548
9. This time, the ``temp`` environment is included.
4649

50+
Upgrading from 1.x
51+
==================
52+
53+
The shell script containing the wrapper functions has been renamed in
54+
the 2.x series to reflect the fact that shells other than bash are
55+
supported. In your startup file, change ``source
56+
/usr/local/bin/virtualenvwrapper_bashrc`` to ``source
57+
/usr/local/bin/virtualenvwrapper.sh``.
58+
4759
=======
4860
Details
4961
=======

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ def find_package_data(
132132

133133
platforms = ('Any',),
134134

135-
scripts = ['virtualenvwrapper_bashrc',
135+
scripts = ['virtualenvwrapper.sh',
136136
],
137137

138138
provides=['virtualenvwrapper',

tests/manual_test_install.sh

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#
55

66
test_dir=$(dirname $0)
7-
source "$test_dir/../virtualenvwrapper_bashrc"
7+
source "$test_dir/../virtualenvwrapper.sh"
88

99
export WORKON_HOME="${TMPDIR:-/tmp}/WORKON_HOME"
1010

@@ -14,6 +14,7 @@ oneTimeSetUp() {
1414
rm -rf "$WORKON_HOME"
1515
mkdir -p "$WORKON_HOME"
1616
mkvirtualenv "installtest"
17+
(cd "$test_dir/.." && make sdist)
1718
}
1819

1920
oneTimeTearDown() {
@@ -29,7 +30,7 @@ test_install () {
2930
pip install "$dist_dir/virtualenvwrapper-$VERSION.tar.gz"
3031
RC=$?
3132
assertTrue "Error code $RC" "[ $RC -eq 0 ]"
32-
assertTrue "Missing wrapper script" "[ -f $WORKON_HOME/installtest/bin/virtualenvwrapper_bashrc ]"
33+
assertTrue "Missing wrapper script" "[ -f $WORKON_HOME/installtest/bin/virtualenvwrapper.sh ]"
3334
}
3435

3536
. "$test_dir/shunit2"

tests/test.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#set -x
44

55
test_dir=$(dirname $0)
6-
source "$test_dir/../virtualenvwrapper_bashrc"
6+
source "$test_dir/../virtualenvwrapper.sh"
77

88
export WORKON_HOME="${TMPDIR:-/tmp}/WORKON_HOME"
99

@@ -44,7 +44,7 @@ test_virtualenvwrapper_verify_workon_home_missing_dir() {
4444
test_virtualenvwrapper_verify_workon_home_missing_dir_quiet_init() {
4545
old_home="$WORKON_HOME"
4646
export WORKON_HOME="$WORKON_HOME/not_there"
47-
output=`$SHELL $test_dir/../virtualenvwrapper_bashrc 2>&1`
47+
output=`$SHELL $test_dir/../virtualenvwrapper.sh 2>&1`
4848
assertSame "" "$output"
4949
WORKON_HOME="$old_home"
5050
}

tests/test_add2virtualenv.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#set -x
44

55
test_dir=$(dirname $0)
6-
source "$test_dir/../virtualenvwrapper_bashrc"
6+
source "$test_dir/../virtualenvwrapper.sh"
77

88
export WORKON_HOME="${TMPDIR:-/tmp}/WORKON_HOME"
99

tests/test_cd.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#set -x
44

55
test_dir=$(dirname $0)
6-
source "$test_dir/../virtualenvwrapper_bashrc"
6+
source "$test_dir/../virtualenvwrapper.sh"
77

88
export WORKON_HOME="${TMPDIR:-/tmp}/WORKON_HOME"
99

tests/test_cp.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#set -x
44

55
test_dir=$(dirname $0)
6-
source "$test_dir/../virtualenvwrapper_bashrc"
6+
source "$test_dir/../virtualenvwrapper.sh"
77

88
export WORKON_HOME="${TMPDIR:-/tmp}/WORKON_HOME"
99

tests/test_ls.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#set -x
44

55
test_dir=$(dirname $0)
6-
source "$test_dir/../virtualenvwrapper_bashrc"
6+
source "$test_dir/../virtualenvwrapper.sh"
77

88
export WORKON_HOME="${TMPDIR:-/tmp}/WORKON_HOME"
99

tests/test_mkvirtualenv.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#set -x
44

55
test_dir=$(dirname $0)
6-
source "$test_dir/../virtualenvwrapper_bashrc"
6+
source "$test_dir/../virtualenvwrapper.sh"
77

88
export WORKON_HOME="${TMPDIR:-/tmp}/WORKON_HOME"
99

0 commit comments

Comments
 (0)