https://github.com/matthewfeickert/venv-activate
Bash creation and tab completion of activation of Python virtual environments
https://github.com/matthewfeickert/venv-activate
bash python tab-completion venv virtual-environments
Last synced: 6 months ago
JSON representation
Bash creation and tab completion of activation of Python virtual environments
- Host: GitHub
- URL: https://github.com/matthewfeickert/venv-activate
- Owner: matthewfeickert
- License: bsd-3-clause
- Created: 2019-04-08T05:33:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-01-17T15:14:30.000Z (over 5 years ago)
- Last Synced: 2025-04-12T21:16:17.198Z (6 months ago)
- Topics: bash, python, tab-completion, venv, virtual-environments
- Language: Shell
- Homepage:
- Size: 14.6 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# venv-activate
Bash tab completion of creation and activation of Python virtual environments (installed under `$HOME/.venvs` by default)
## Installation
If `_venv-activate.sh` is installed at `/opt/_venv-activate/_venv-activate.sh` then if the following is added to a user's `~/.bashrc`
```
# Enable tab completion of Python virtual environments
if [ -f /opt/_venv-activate/_venv-activate.sh ]; then
_VENV_ACTIVATE_HOME="${HOME}/.venvs"
_VENV_ACTIVATE_PYTHON=$(which python3)
. /opt/_venv-activate/_venv-activate.sh
fi
```
then a user can tab complete for possible Python virtual environments to activate with `venv-activate` (assuming that the path of `VENV_ACTIVATE_HOME` actually exists).
## Example
```
$ venv-create data-science
```
results in
```
(data-science) $ python -m pip install --upgrade pip setuptools wheel
# Created virtual environment data-science
# To activate it run:
venv-activate data-science
# To exit the virtual environment run:
deactivate
```
and then
```
$ venv-activate #tab
```
results in
```
$ venv-activate
data-science
```
and tab completing `data-science` and hitting `enter` then activates the virtual environment
```
(data-science) $
```
## API
### `venv-create`
Create a new Python virtual environment.
```
$ venv-create sandbox
(sandbox) $ python -m pip install --upgrade pip setuptools wheel
# Created virtual environment sandbox
# To activate it run:
venv-activate sandbox
# To exit the virtual environment run:
deactivate
```
### `venv-activate`
Activate an existing Python virtual environment.
```
$ venv-activate sandbox
(sandbox) $
```
### `venv-remove`
Remove an existing Python virtual environment by deleting the `venv` directory (which holds the Python runtime and installed packages).
```
$ venv-remove sandbox
# Deleted virtual environment sandbox
```
### `venv-info`
Show version information for Python and pip, and how many packages are installed inside the Python virtual environment.
```
$ venv-info sandbox
# Python : v3.7.5
# pip : v19.3.1
# installed: 1 packages
```
## Authors
Primary Author: [Matthew Feickert](http://www.matthewfeickert.com/)