Difference between revisions of "Python/Virtualenv"

From ArchWiki
Jump to: navigation, search
(Created page with "Category:Development (English) ==Introduction== ''virtualenv'' is a python tool written by Ian Bicking and used to create isolated environments for python in which you can i...")
 
(22 intermediate revisions by 13 users not shown)
Line 1: Line 1:
[[Category:Development (English)]]
+
[[Category:Development]]
 +
{{Out of date}}
  
==Introduction==
+
''virtualenv'' is a Python tool written by Ian Bicking and used to create isolated environments for Python in which you can install packages without interfering with the other virtualenvs nor with the system Python's packages.
''virtualenv'' is a python tool written by Ian Bicking and used to create isolated environments for python in which you can install packages without interfering with the other virtualenvs nor with the system python's packages.
+
The present article covers the installation of the ''virtualenv'' package and its companion command line utility ''virtualenvwrapper'' designed by Doug Hellmann to (greatly) improve your work flow. A quick how-to to help you to begin working inside virtual environment is then provided.
The present article cover the installation of the ''virtualenv'' package and its companion command line utility ''virtualenvwrapper'' designed by Doug Hellmann to (greatly) improve your work flow. A quick how-to to help you to begin working inside virtual environment is then provided.
+
  
 
==Virtual Environments at a glance==
 
==Virtual Environments at a glance==
''virtualenv'' is a tool designated to address the problem of dealing with packages' dependencies while maintaining different versions that suite projects' needs. For example, if you work on two Django web sites, say one that needs Django 1.2 while the other needs the good old 0.96. You have no way to keep both versions if you install them into /usr/lib/python2/site-packages . Thanks to virtualenv it's possible, by creating to isolated environment, to have the two development environment to play along nicely.
+
''virtualenv'' is a tool designated to address the problem of dealing with packages' dependencies while maintaining different versions that suit projects' needs. For example, if you work on two Django web sites, say one that needs Django 1.2 while the other needs the good old 0.96. You have no way to keep both versions if you install them into /usr/lib/python2/site-packages . Thanks to virtualenv it's possible, by creating two isolated environments, to have the two development environment to play along nicely.
 
+
''vitualenvwrapper'' take ''virtualenv'' a step further by providing convenient command you can invoke from your favourite console.
+
  
 +
''vitualenvwrapper'' takes ''virtualenv'' a step further by providing convenient commands you can invoke from your favorite console.
  
 
== Virtualenv ==
 
== Virtualenv ==
  
Currently ''virtualenv'' only support Python up to version 2.7. If you really need virtual environment on Python 3 check out the virtualenv3 project on Bitbucket : http://bitbucket.org/brandon/virtualenv3.
+
''virtualenv'' supports Python 2.5+ and Python 3.x.
  
 
===Installation===
 
===Installation===
Simply install python-virtualenv from the community repository and you're done :
+
Simply install from the community repository:
 +
# pacman -S python2-virtualenv
 +
or
 
  # pacman -S python-virtualenv
 
  # pacman -S python-virtualenv
  
Line 23: Line 24:
  
 
The typical use case is:
 
The typical use case is:
* Create a folder for the new virtualenv :  
+
* Create a folder for the new virtualenv:
  $ mkdir ~/.virtualenvs/my_env
+
  $ mkdir -p ~/.virtualenvs/my_env
* Create the virtualenv, here without package inheritance from the system's installation :  
+
* Create the virtualenv:  
  $ virtualenv --no-site-pacakges ~/.virtualenvs/my_env
+
  $ virtualenv2 ~/.virtualenvs/my_env
* Activate he virtualenv :  
+
* Activate the virtualenv:  
 
  $ source ~/.virtualenvs/my_env/bin/activate
 
  $ source ~/.virtualenvs/my_env/bin/activate
* Install some package inside the virtualenv (say, Django) :  
+
* Install some package inside the virtualenv (say, Django):
  (my_env)$ easy_install django
+
  (my_env)$ pip install django
 
* Do your things
 
* Do your things
* Leave the virtualenv :  
+
* Leave the virtualenv:
 
  (my_env)$ deactivate
 
  (my_env)$ deactivate
  
 
== Virtualenvwrapper ==
 
== Virtualenvwrapper ==
  
''virtualenvwrapper'' allow more natural command line interactions with your virtualenvs by exposing several usefull commands to create, activate and remove virtualenvs. As ''virtualenv'' this package does not support currently Python 3.x.
+
''virtualenvwrapper'' allows more natural command line interaction with your virtualenvs by exposing several useful commands to create, activate and remove virtualenvs. This package is a wrapper for both {{Pkg|python-virtualenv}} and {{Pkg|python2-virtualenv}}.
 
+
 
===Installation===
 
===Installation===
Install python-virtualenvwrapper from community, if you have not installed python-virtualenv yet, it will be installed now as a dependency.
+
[[pacman|Install]] the {{Pkg|python-virtualenvwrapper}} package from the [[Official Repositories|official repositories]].
# pacman -S python-virtualenvwrapper
+
 
 +
Now add the following lines to your {{ic|~/.bashrc}}:
  
Now add the following line to your .bashrc :
 
source /usr/bin/virtualenvwrapper.sh
 
 
  export WORKON_HOME=~/.virtualenvs
 
  export WORKON_HOME=~/.virtualenvs
 +
source /usr/bin/virtualenvwrapper.sh
 +
 +
If you are not using python3 by default (check the output of {{ic|$ python --version}}) you also need to add the following line to your {{ic|~/.bashrc}} prior sourcing the {{ic|virtualenvwrapper.sh}} script. The current version of the {{ic|virtualenvwrapper-python}} package only works with python3. It can create python2 virtualenvs fine though.
 +
 +
VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3
  
Re-open your console and create the WORKON_HOME folder :
+
Re-open your console and create the {{ic|WORKON_HOME}} folder:
 
  $ mkdir $WORKON_HOME
 
  $ mkdir $WORKON_HOME
  
 
===Basic Usage===
 
===Basic Usage===
The main information source on virtualenvwrapper usage (and extension capability) is Doug Hellmann's page : http://www.doughellmann.com/docs/virtualenvwrapper/.
+
The main information source on virtualenvwrapper usage (and extension capability) is Doug Hellmann's [http://www.doughellmann.com/docs/virtualenvwrapper/ page].
  
* Create the virtualenv:  
+
* Create the virtualenv:
  $ mkvirtualenv --no-site-pacakges my_env
+
  $ mkvirtualenv -p /usr/bin/python2.7 my_env
* Activate he virtualenv :  
+
* Activate the virtualenv:
  $ workon my_enve
+
  $ workon my_env
* Install some package inside the virtualenv (say, Django) : (my_env)$ easy_install django
+
* Install some package inside the virtualenv (say, Django):
 +
$ (my_env)$ pip install django
 
* Do your things
 
* Do your things
* Leave the virtualenv :  
+
* Leave the virtualenv:  
 
  (my_env)$ deactivate
 
  (my_env)$ deactivate
  
 
== See Also ==
 
== See Also ==
<ul>
+
*[http://pypi.python.org/pypi/virtualenv virtualenv Pypi page]
<li>[http://pypi.python.org/pypi/virtualenv virtualenv Pypi page]</li>
+
*[http://wiki.pylonshq.com/display/pylonscookbook/Using+a+Virtualenv+Sandbox Tutorial for virtualenv]
<li>[http://wiki.pylonshq.com/display/pylonscookbook/Using+a+Virtualenv+Sandbox Tutorial for virtualenv]</li>
+
*[http://www.doughellmann.com/docs/virtualenvwrapper/ virtualenvwrapper page at Doug Hellmann's]
<li>[http://www.doughellmann.com/docs/virtualenvwrapper/ virtualenvwrapper page at Doug Hellmann's]</li>
+
</ul>
+

Revision as of 08:14, 1 July 2013

Tango-view-refresh-red.pngThis article or section is out of date.Tango-view-refresh-red.png

Reason: please use the first argument of the template to provide a brief explanation. (Discuss in Talk:Python/Virtualenv#)

virtualenv is a Python tool written by Ian Bicking and used to create isolated environments for Python in which you can install packages without interfering with the other virtualenvs nor with the system Python's packages. The present article covers the installation of the virtualenv package and its companion command line utility virtualenvwrapper designed by Doug Hellmann to (greatly) improve your work flow. A quick how-to to help you to begin working inside virtual environment is then provided.

Virtual Environments at a glance

virtualenv is a tool designated to address the problem of dealing with packages' dependencies while maintaining different versions that suit projects' needs. For example, if you work on two Django web sites, say one that needs Django 1.2 while the other needs the good old 0.96. You have no way to keep both versions if you install them into /usr/lib/python2/site-packages . Thanks to virtualenv it's possible, by creating two isolated environments, to have the two development environment to play along nicely.

vitualenvwrapper takes virtualenv a step further by providing convenient commands you can invoke from your favorite console.

Virtualenv

virtualenv supports Python 2.5+ and Python 3.x.

Installation

Simply install from the community repository:

# pacman -S python2-virtualenv

or

# pacman -S python-virtualenv

Basic Usage

An extended tutorial on how use virtualenv for sandboxing can be found here.

The typical use case is:

  • Create a folder for the new virtualenv:
$ mkdir -p ~/.virtualenvs/my_env
  • Create the virtualenv:
$ virtualenv2 ~/.virtualenvs/my_env
  • Activate the virtualenv:
$ source ~/.virtualenvs/my_env/bin/activate
  • Install some package inside the virtualenv (say, Django):
(my_env)$ pip install django
  • Do your things
  • Leave the virtualenv:
(my_env)$ deactivate

Virtualenvwrapper

virtualenvwrapper allows more natural command line interaction with your virtualenvs by exposing several useful commands to create, activate and remove virtualenvs. This package is a wrapper for both python-virtualenv and python2-virtualenv.

Installation

Install the python-virtualenvwrapper package from the official repositories.

Now add the following lines to your ~/.bashrc:

export WORKON_HOME=~/.virtualenvs
source /usr/bin/virtualenvwrapper.sh

If you are not using python3 by default (check the output of $ python --version) you also need to add the following line to your ~/.bashrc prior sourcing the virtualenvwrapper.sh script. The current version of the virtualenvwrapper-python package only works with python3. It can create python2 virtualenvs fine though.

VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3

Re-open your console and create the WORKON_HOME folder:

$ mkdir $WORKON_HOME

Basic Usage

The main information source on virtualenvwrapper usage (and extension capability) is Doug Hellmann's page.

  • Create the virtualenv:
$ mkvirtualenv -p /usr/bin/python2.7 my_env
  • Activate the virtualenv:
$ workon my_env
  • Install some package inside the virtualenv (say, Django):
$ (my_env)$ pip install django
  • Do your things
  • Leave the virtualenv:
(my_env)$ deactivate

See Also