Package: virtualenv-api
virtualenvis a tool to create isolated Python environments. Unfortunately,
it does not expose a native Python API.  This package aims to provide an API in
the form of a wrapper around virtualenv.It can be used to create and delete environments and perform package management
inside the environment.Full support is provided for all supported versions of Python.InstallationThe latest stable release is available onPyPi:$ pip install virtualenv-apiPlease note that the distribution is namedvirtualenv-api, yet the Python
package is namedvirtualenvapi.Alternatively, you may fetch the latest version from git:$ pip install git+https://github.com/sjkingo/virtualenv-api.gitUsageTo begin managing an environment (it will be created if it does not exist):fromvirtualenvapi.manageimportVirtualEnvironmentenv=VirtualEnvironment('/path/to/environment/name')If you have already activated a virtualenv and wish to operate on it, simply
callVirtualEnvironmentwithout the path argument:env=VirtualEnvironment()TheVirtualEnvironmentconstructor takes some optional arguments (their defaults are shown below):python=None- specify the Python interpreter to use. Defaults to the default system interpreter(new in 2.1.3)cache=None- existing directory to override the default pip download cachereadonly=False- prevent all operations that could potentially modify the environment(new in 2.1.7)system_site_packages=False- include system site packages in operations on the environment(new in 2.1.14)OperationsOnce you have aVirtualEnvironmentobject, you can perform operations on it.Check if themezzaninepackage is installed:>>>env.is_installed('mezzanine')FalseInstall the latest version of themezzaninepackage:>>>env.install('mezzanine')A wheel of the latest version of themezzaninepackage (new in
2.1.4):>>>env.wheel('mezzanine')Install version 1.4 of thedjangopackage (this is pip’s syntax):>>>env.install('django==1.4')Upgrade thedjangopackage to the latest version:>>>env.upgrade('django')Upgrade all packages to their latest versions (new in 2.1.7):>>>env.upgrade_all()Uninstall themezzaninepackage:>>>env.uninstall('mezzanine')Packages may be specified as name only (to work on the latest version), using
pip’s package syntax (e.g.django==1.4) or as a tuple of('name', 'ver')(e.g.('django', '1.4')).A package may be installed directly from a git repository (must end
with.git):>>>env.install('git+git://github.com/sjkingo/cartridge-payments.git')New in 2.1.10:A package can be installed in pip’seditablemode by prefixing the package
name with-e(this is pip’s syntax):>>>env.install('-e git+https://github.com/stephenmcd/cartridge.git')New in 2.1.15:Packages in a pip requirements file can be installed by prefixing the
requirements file path with-r:>>>env.install('-r requirements.txt')Instances of the environment provide aninstalled_packagesproperty:>>>env.installed_packages[('django','1.5'),('wsgiref','0.1.2')]A list of package names is also available in the same manner:>>>env.installed_package_names['django','wsgiref']Search for a package on PyPI (changed in 2.1.5: this now returns a
dictionary instead of list):>>>env.search('virtualenv-api'){'virtualenv-api':'An API for virtualenv/pip'}>>>len(env.search('requests'))231The old functionality (pre 2.1.5) ofenv.searchmay be used:>>>list(env.search('requests').items())[('virtualenv-api','An API for virtualenv/pip')]Verbose output from each command is available in the environment’sbuild.logfile, which is appended to with each operation. Any errors are
logged tobuild.err.