an alternative approach to manage virtualenvs from pyenv.
Shell
Switch branches/tags
Clone or download
Latest commit 2d11af8 Aug 20, 2017

README.md

pyenv-virtualenvwrapper

Build Status

An alternative approach to manage virtualenvs from pyenv.

pyenv-virtualenvwrapper is a pyenv plugin which provides a pyenv virtualenvwrapper command to manage your virtualenvs with virtualenvwrapper.

Attention: This plugin is different from pyenv-virtualenv, which provides extended commands like pyenv virtualenv 3.4.1 project_name to directly help out with managing virtualenvs. pyenv-virtualenvwrapper helps in interacting with virtualenvwrapper, but pyenv-virtualenv provides more convenient commands, where virtualenvs are first-class pyenv versions, that can be (de)activated. That's to say, pyenv and virtualenvwrapper are still separated while pyenv-virtualenv is a nice combination.

Installation

Installing python

Because virtualenvwrapper is depending on python, you must first install at least one version of python.

For example, install 2.7.7 and set it as global in pyenv.

$ pyenv install 2.7.7
$ pyenv global 2.7.7

(NOTICE: virtualenvwrapper will not work if you remove the python version which is bound to virtualenvwrapper.)

Installing pyenv-virtualenvwrapper as a pyenv plugin

Installing pyenv-virtualenvwrapper as a pyenv plugin will give you access to the pyenv virtualenvwrapper and pyenv virtualenvwrapper_lazy command.

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

This will install the latest development version of pyenv-virtualenvwrapper into the $(pyenv root)/plugins/pyenv-virtualenvwrapper directory. From that directory, you can check out a specific release tag. To update pyenv-virtualenvwrapper, run git pull to download the latest changes.

Installing with Homebrew (for OS X users)

Mac OS X users can install pyenv-virtualenvwrapper with the Homebrew package manager.

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

brew install pyenv-virtualenvwrapper

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

brew install --HEAD pyenv-virtualenvwrapper

Usage

Using pyenv virtualenvwrapper

To setup a virtualenvwrapper into your shell, just run pyenv virtualenvwrapper. For example,

$ pyenv virtualenvwrapper

or, if you favor virtualenvwrapper_lazy.sh,

$ pyenv virtualenvwrapper_lazy

Using pyvenv instead of virtualenv

To get virtualenvwrapper to create a virtual environment using pyvenv instead of virtualenv, set the PYENV_VIRTUALENVWRAPPER_PREFER_PYVENV environment variable. For example, set the following in your shell initialization config:

export PYENV_VIRTUALENVWRAPPER_PREFER_PYVENV="true"

After you start a new shell with that variable set and initialize via pyenv virtualenvwrapper or pyenv virtualenvwrapper_lazy, any virtual environments created from that shell using mkvirtualenv will be created using pyvenv if it is available in the active Python version (pyvenv is in Python 3.3 or later).

Version History

20140609

  • Add support for creating venv using pyvenv if it is available (#16)

20140321

  • Performance improvement (approx 1.5x+ in common cases) (#13)
  • Add Homebrew installation instructions. (#14)

20140122

  • Display errors when pyenv virtualenvwrapper is invoked as a command
  • Declare VIRTUALENVWRAPPER_PYTHON and VIRTUALENVWRAPPER_VIRTUALENV properly to follow the version changes in pyenv (#9, #10, #11)
  • Install virtualenvwrapper if it is not installed
  • Add --unset option for virtualenvwrapper and virtualenvwrapper_lazy
  • Fix broken install script
  • Add tests

20130614

  • Improve error logging.

20130306

  • Initial public release.

License

(The MIT License)

  • Copyright (c) 2013 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.