CHANGELOG Copy Section

Version History Copy Chapter

v1.4.0 Copy Chapter

v1.3.0 Copy Chapter

v1.2.6 Copy Chapter

v1.2.5 Copy Chapter

v1.2.4 Copy Chapter

v1.2.3 Copy Chapter

v1.2.2 Copy Chapter

v1.2.1 Copy Chapter

v1.2.0 Copy Chapter

v1.1.5 Copy Chapter

* Fix install script (#290, #302)

v1.1.4 Copy Chapter

* Support newer conda (#290)
* Prefer python3.x executable if available (#206, #282, #296)

v1.1.3 Copy Chapter

* No code changes since 1.1.2

v1.1.2 Copy Chapter

* Use custom get-pip URL based on the target version (#253, #254, #255)
* Source conda 4.4.4 shell files (#251)
* Evaluate force flag before testing if venv exists (#232)

v1.1.1 Copy Chapter

* Set CONDA_PREFIX to make is useable in conda activate/deactivate scripts (#224)
* Generate pydoc executable after creating new virtualenv (#197, #230)

v1.1.0 Copy Chapter

* fish: use "set -gx" instead of "setenv" (#215, #216, #217, #218)

v1.0.0 Copy Chapter

* Use similar versioning scheme as pyenv; YYYYMMDD -> X.Y.Z

v20160716 Copy Chapter

* Suppress activate/deactivate messages by default (#169, #170, #171)
* Source conda package activate/deactivat scripts if exist (#173)
* Use source in favor of . for fish (#175)
* Use python -m venv instead of pyvenv due to deprecation of pyvenv after 3.6 (#184, #185)

v20160315 Copy Chapter

* Evaluate ${PATH} when outputted code is eval'd. (#154)
* Set proper CONDA_DEFAULT_ENV for shorter name (#160)

v20160202 Copy Chapter

* Install virtualenv 13.1.2 for CPython/Stackless 3.2.x (yyuu/pyenv#531)

v20160112 Copy Chapter

* Fix problem with virtualenv to look up executables from source version with --system-site-packages (#62)

v20151229 Copy Chapter

* Fix deactivate error on fish (#136)

v20151222 Copy Chapter

* Improved interoperability with Anaconda/Miniconda (#103, #106, #107, #108)
* Create virtualenv inside envs directory of source version, like Anaconda/Miniconda (#103, #107)
* Rewrite pyenv activate and pyenv deactivate without using scripts provided by virtualenv and conda (#51, #69, #103, #104, #121)
* Improve the pyenv activate behaviour on multiple versions (#105, #111)
* Reject creating a virtualenv named system (yyuu/pyenv#475)
* Add --skip-aliases to pyenv virtualenvs (#120)
* Stop showing version not installed warning messages in precmd (#49)

v20151103 Copy Chapter

* Passing return value from executed command. (#100)
* Add workaround for commands installed in a virtual environment created by pyvenv (#62)
* init: zsh: prepend hook to precmd_functions (#101)

v20151006 Copy Chapter

* Ignore user's site-packages on ensurepip/get-pip (#89)
* Find python-config from source version if current version is a virtualenv
* Fix pyenv-virtualenv-init script for fish where command was in string and not being evaluated (#98)
* Add foolproof for -p argument. (yyuu/pyenv#98)

v20150719 Copy Chapter

* Add support for conda environments created by Anaconda/Miniconda (#91)
* Look up commands for original version as well if the environment is created with --system-site-packages (#62)
* Add error message if the source version is not installed (#83)

v20150526 Copy Chapter

* Use typeset -g with precmd_functions (#75)
* activate: display setup instructions only with PYENV_VIRTUALENV_INIT=0 (#78)
* Ignore failure of pyenv activate (#68)

v20150119 Copy Chapter

* Ignore errors from pyenv-version-name since it might fail if there is configuration error (yyuu/pyenv#291)
* The _shell_ version set in activate should be unset in deactivate (#61)
* Anaconda has activate script nevertheless it is not a virtual environment (#65)

v20141106 Copy Chapter

* Stop creating after ensurepip since it has done by ensurepip itself
* Suppress some useless warnings from pyenv virtualenv-init

v20141012 Copy Chapter

* Fix warnings from shellcheck to improve support for POSIX sh (#40)
* Do not allow whitespace in VIRTUALENV_NAME (#44)
* Should not persist PYENV_DEACTIVATE after automatic deactivation (#47, #48)

v20140705 Copy Chapter

* Display information on auto-(de)?activation
* Support manual (de)?activation with auto-activation enabled (#32, #34)
* Exit as error when (de)?activation failed
* Use https://bootstrap.pypa.io/ to install setuptools and pip
* Create backup of original virtualenv within $(pyenv root)/versions when --upgrade

v20140615 Copy Chapter

* Fix incompatibility issue of pyenv activate and pyenv deactivate (#26)
* Workaround for the issue with pyenv-which-ext (#26)

v20140614 Copy Chapter

* Add pyenv virtualenv-init to enable auto-activation feature (#24)
* Create symlinks for executables with version suffix (yyuu/pyenv#182)

v20140602 Copy Chapter

* Use new style GH raw url to avoid redirects (raw.github.com -> raw.githubusercontent.com)
* Repaired virtualenv activation and deactivation for the fish shell (#23)

v20140421 Copy Chapter

* Display error if pyenv activate was invoked as a command
* Fix completion of pyenv activate (#15)
* Use virtualenv instead of pyvenv if -p has given (yyuu/pyenv#158)

v20140123 Copy Chapter

* Add activate and deactivate to make pyenv-virtualenv work with jedi (#9)
* Use ensurepip to install pip if it is available
* Unset PIP_REQUIRE_VENV to avoid problem on the installation of virtualenv (#10)
* Add tests

v20140110.1 Copy Chapter

* Fix install script

v20140110 Copy Chapter

* Support environment variables of EZ_SETUP and GET_PIP.
* Support a short option -p of virtualenv.

v20131216 Copy Chapter

* Use latest release of setuptools and pip if the version not given via environment variables.

v20130622 Copy Chapter

* Removed bundled virtualenv.py script. Now pyenv-virtualenv installs virtualenv package into source version and then use it.
* On Python 3.3+, use pyvenv as virtualenv command if virtualenv is not available.
* Install setuptools and pip into environments created by pyvenv.

v20130614 Copy Chapter

* Add pyenv virtualenvs to list all virtualenv versions.
EXPERIMENTAL*: Add --upgrade option to re-create virtualenv with migrating packages

v20130527 Copy Chapter

* Remove python-virtualenv which was no longer used.
* Change the installation path of the virtualenv.py script. (./libexec -> ./libexec/pyenv-virtualenv/${VIRTUALENV_VERSION})
* Download virtualenv.py if desired version has not been installed.

v20130507 Copy Chapter

* Display virtualenv information in --help and --version
* Update virtualenv version; 1.8.4 -> 1.9.1

v20130307 Copy Chapter

* Rename the project; s/python-virtualenv/pyenv-virtualenv/g
* The pyenv-virtualenv script is not depending on python-virtualenv now.
python-virtualenv will left for compatibility and will not continue for future releases.
* Update virtualenv version; 1.8.2 -> 1.8.4

v20130218 Copy Chapter

* Add pyenv 0.2.x (rbenv 0.4.x) style help messages.

v20121023 Copy Chapter

* Create virtualenv with exact name of python executables.
* Changed command-line options of python-virtualenv.
First argument should be a path to the python executable.
* Add install script.

v20120927 Copy Chapter

* Initial public release.

---

README Copy Section

pyenv-virtualenv

[](https://gitter.im/yyuu/pyenv-virtualenv?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[](https://travis-ci.org/pyenv/pyenv-virtualenv)

pyenv-virtualenv is a pyenv plugin
that provides features to manage virtualenvs and conda environments
for Python on UNIX-like systems.

(NOTICE: If you are an existing user of virtualenvwrapper
and you love it, pyenv-virtualenvwrapper may help you
(additionally) to manage your virtualenvs.)

Installation Copy Chapter

Installing as a pyenv plugin Copy Section

This will install the latest development version of pyenv-virtualenv into
the $(pyenv root)/plugins/pyenv-virtualenv directory.

Important note: If you installed pyenv into a non-standard directory, make
sure that you clone this repo into the 'plugins' directory of wherever you
installed into.

From inside that directory you can:
- Check out a specific release tag.
- Get the latest development release by running git pull to download the
latest changes.

💡 WSL note: If you're using WSL, we recommend setting Git to use Unix-style line endings to prevent script execution errors:

git config --global core.autocrlf input

1. Check out pyenv-virtualenv into plugin directory

git clone https://github.com/pyenv/pyenv-virtualenv.git $(pyenv root)/plugins/pyenv-virtualenv

For the Fish shell:

git clone https://github.com/pyenv/pyenv-virtualenv.git (pyenv root)/plugins/pyenv-virtualenv

2. (OPTIONAL) Add pyenv virtualenv-init to your shell to enable auto-activation of virtualenvs. This is entirely optional but pretty useful. See "Activate virtualenv" below.

echo 'eval "$(pyenv virtualenv-init -)"' >> ~/.bashrc

Fish shell note: Add this to your ~/.config/fish/config.fish

status --is-interactive; and pyenv virtualenv-init - | source

Zsh note: Modify your ~/.zshrc file instead of ~/.bashrc.

3. Restart your shell to enable pyenv-virtualenv

exec "$SHELL"

Installing with Homebrew (for macOS users) Copy Section

macOS users can install pyenv-virtualenv with the
Homebrew package manager.
This will give you access to the pyenv-virtualenv command. If you have pyenv
installed, you will also be able to use the pyenv virtualenv command.

*This is the recommended method of installation if you installed pyenv
with Homebrew.*

brew install pyenv-virtualenv

Or, if you would like to install the latest development release:

brew install --HEAD pyenv-virtualenv

After installation, you'll still need to do
Pyenv shell setup steps
then add

eval "$(pyenv virtualenv-init -)"

Usage Copy Chapter

Using pyenv virtualenv with pyenv pyenv virtualenv with pyenv')" title="Copy section prompt for LLMs"> Copy Section

To create a virtualenv for the Python version used with pyenv, run
pyenv virtualenv, specifying the Python version you want and the name
of the virtualenv directory. For example,

pyenv virtualenv 2.7.10 my-virtual-env-2.7.10

will create a virtualenv based on Python 2.7.10 under $(pyenv root)/versions in a
folder called my-virtual-env-2.7.10.

pyenv virtualenv forwards any options to the underlying command that actually
creates the virtual environment (conda, virtualenv, or python -m venv).
See the output of pyenv virtualenv --help for details.

Create virtualenv from current version Copy Section

If there is only one argument given to pyenv virtualenv, the virtualenv will
be created with the given name based on the current pyenv Python version.

$ pyenv version
3.4.3 (set by /home/yyuu/.pyenv/version)
$ pyenv virtualenv venv34

List existing virtualenvs Copy Section

pyenv virtualenvs shows you the list of existing virtualenvs and conda environments.

$ pyenv shell venv34
$ pyenv virtualenvs
  miniconda3-3.9.1 (created from /home/yyuu/.pyenv/versions/miniconda3-3.9.1)
  miniconda3-3.9.1/envs/myenv (created from /home/yyuu/.pyenv/versions/miniconda3-3.9.1)
  2.7.10/envs/my-virtual-env-2.7.10 (created from /home/yyuu/.pyenv/versions/2.7.10)
  3.4.3/envs/venv34 (created from /home/yyuu/.pyenv/versions/3.4.3)
  my-virtual-env-2.7.10 (created from /home/yyuu/.pyenv/versions/2.7.10)
* venv34 (created from /home/yyuu/.pyenv/versions/3.4.3)

There are two entries for each virtualenv, and the shorter one is just a symlink.

Activate virtualenv Copy Section

Some external tools (e.g. jedi) might
require you to activate the virtualenv and conda environments.

If eval "$(pyenv virtualenv-init -)" is configured in your shell, pyenv-virtualenv will automatically activate/deactivate virtualenvs on entering/leaving directories which contain a .python-version file that contains the name of a valid virtual environment as shown in the output of pyenv virtualenvs (e.g., venv34 or 3.4.3/envs/venv34 in example above) . .python-version files are used by pyenv to denote local Python versions and can be created and deleted with the pyenv local command.

You can also activate and deactivate a pyenv virtualenv manually:

pyenv activate <name>
pyenv deactivate

Delete existing virtualenv Copy Section

Removing the directories in $(pyenv root)/versions and $(pyenv root)/versions/{version}/envs will delete the virtualenv, or you can run:

pyenv uninstall my-virtual-env

You can also delete existing virtualenvs by using virtualenv-delete command, e.g. you can run:

pyenv virtualenv-delete my-virtual-env

virtualenv and venv Copy Section

There is a venv module available
for CPython 3.3 and newer.
It provides an executable module venv which is the successor of virtualenv
and distributed by default.

pyenv-virtualenv uses python -m venv if it is available and the virtualenv
command is not available.

Anaconda and Miniconda Copy Section

You can manage conda environments by conda create as same manner as standard Anaconda/Miniconda installations.
To use those environments, you can use pyenv activate and pyenv deactivate.

$ pyenv version
miniconda3-3.9.1 (set by /home/yyuu/.pyenv/version)
$ conda env list
conda environments:

#
myenv                    /home/yyuu/.pyenv/versions/miniconda3-3.9.1/envs/myenv
root                  *  /home/yyuu/.pyenv/versions/miniconda3-3.9.1
$ pyenv activate miniconda3-3.9.1/envs/myenv
discarding /home/yyuu/.pyenv/versions/miniconda3-3.9.1/bin from PATH
prepending /home/yyuu/.pyenv/versions/miniconda3-3.9.1/envs/myenv/bin to PATH
$ python --version
Python 3.4.3 :: Continuum Analytics, Inc.
$ pyenv deactivate
discarding /home/yyuu/.pyenv/versions/miniconda3-3.9.1/envs/myenv/bin from PATH

If conda is available, pyenv virtualenv will use it to create environment by conda create.

$ pyenv version
miniconda3-3.9.1 (set by /home/yyuu/.pyenv/version)
$ pyenv virtualenv myenv2
$ conda env list
conda environments:

#
myenv                    /home/yyuu/.pyenv/versions/miniconda3-3.9.1/envs/myenv
myenv                    /home/yyuu/.pyenv/versions/miniconda3-3.9.1/envs/myenv2
root                  *  /home/yyuu/.pyenv/versions/miniconda3-3.9.1

You can use version like miniconda3-3.9.1/envs/myenv to specify conda environment as a version in pyenv.

$ pyenv version
miniconda3-3.9.1 (set by /home/yyuu/.pyenv/version)
$ pyenv shell miniconda3-3.9.1/envs/myenv
$ which python
/home/yyuu/.pyenv/versions/miniconda3-3.9.1/envs/myenv/bin/python

Special environment variables Copy Section

You can set certain environment variables to control pyenv-virtualenv.

* PYENV_VIRTUALENV_CACHE_PATH, if set, specifies a directory to use for
caching downloaded package files.
* VIRTUALENV_VERSION, if set, forces pyenv-virtualenv to install the desired
version of virtualenv. If virtualenv has not been installed,
pyenv-virtualenv will try to install the given version of virtualenv.
* GET_PIP, if set and venv is preferred over virtualenv,
use get_pip.py from the specified location.
* GET_PIP_URL, if set and venv is preferred over
virtualenv, download get_pip.py from the specified URL.
* PIP_VERSION, if set and venv is preferred
over virtualenv, install the specified version of pip.
* PYENV_VIRTUALENV_VERBOSE_ACTIVATE, if set, shows some verbose outputs on activation and deactivation
* PYENV_VIRTUALENV_PROMPT, if set, allows users to customize how pyenv-virtualenv modifies their shell prompt. The default prompt ("(venv)") is overwritten with any user-specified text. Specify the location of the virtual environment name with the string {venv}. For example, the default prompt string would be ({venv}).

Version History Copy Chapter

See CHANGELOG.md.

License Copy Section

(The MIT License)

* Copyright (c) 2015 Yamashita, Yuu

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---