Skip to content

Instantly share code, notes, and snippets.

@smetroid

smetroid/activatevenv.plugin.README.md

Forked from kishannareshpal/activatevenv.plugin.README.md
Created February 7, 2024 22:38
Show Gist options
  • Save smetroid/e91f2ba50a6bf338f80bcfb74cb6cd06 to your computer and use it in GitHub Desktop.
Save smetroid/e91f2ba50a6bf338f80bcfb74cb6cd06 to your computer and use it in GitHub Desktop.
Download ZIP
Automatically activate python virtual environment when changing directory. In other words, it does `source ./venv/bin/activate` for you!
Raw
README.md

This is a custom shell script I wrote in order to ease my workflow when dealing with Python Virtual Environments.

Installation

Download the activatevenv.plugin.sh into your computer.

oh-my-zsh

  1. Download the script into $ZSH_CUSTOM/plugins/<plugin_name>/activatevenv/. See oh-my-zsh Plugin Customization Wiki
  # Use curl or download manually from https://git.io/JLBHr
  (mkdir activatevenv; cd activatevenv) && curl -L --url https://git.io/JLBHr --output ./activatevenv/activatevenv.plugin.zsh
  1. Edit your ~/.zshrc:
  …
  # Add activatevenv to your list of plugins and restart the terminal.
  plugins=(... , activatevenv)
  …

Manually

  1. Simply copy and paste the script to the bottom of your ~/.bashrc or ~/.zshrc and restart your terminal.

Usage

For existing projects, simply cd into your any directory that contains either a venv/, .venv/ virtualenv created and the script will activate it automatically (Just as you would do with source ./venv/bin/activate) If you are creating a new virtualenv run python -m <venv|virtualenv> <venv|.venv> in your root directory and to activate it manually use call activatevenv (or if you cd back into your project it will automatically activate it without the need of calling activatevenv).

Raw
activatevenv.plugin.sh
# Automatically activates venv if ./venv/ exists in curent directory
# Go to your project folder, run "pip virtualenv <.venv|venv>", so your project folder
# has a <.venv|venv> folder at the top level
# .
# ├── <other_project_files>
# ├── ...
# └── <.venv|venv>
# ├── bin
# ├── include
# └── lib
#
# The virtualenv will be activated automatically when you enter the directory.
# To deactivate run `deactivate` and to manually activate run `activatevenv`
function activatevenv() {
# Names of possible virtualenv directories
VIRTUALENV_DIRS=("venv/" ".venv/" "${PWD##*/}")
for dir in $VIRTUALENV_DIRS; do
if [[ -d "${dir}" ]]; then
# Found a possible venv directory
# Try activating the venv
if [[ -e "./${dir}/bin/activate" ]]; then
source ./$dir/bin/activate
echo "Virtual environment activated automatically"
fi
fi
done
}
activatevenv
# Extension for `cd` command in order to automatically acticate virtualenv
function cd() {
builtin cd $1
# Try activating venv
activatevenv
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment