[Fix #112] Add documentation for python
This commit is contained in:
parent
c9561e1b87
commit
e541283126
45
modules/python/README.md
Normal file
45
modules/python/README.md
Normal file
|
@ -0,0 +1,45 @@
|
||||||
|
Python
|
||||||
|
======
|
||||||
|
|
||||||
|
Enables local Python package installation.
|
||||||
|
|
||||||
|
Local Package Installation
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
Since version 2.6, Python supports per user package installation, as defined in
|
||||||
|
[PEP 370][1].
|
||||||
|
|
||||||
|
This module prepends per user site directories to the relevant path variables to
|
||||||
|
enable the execution of user installed scripts and the reading of documentation.
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
|
||||||
|
Install packages into the per user site directory with `easy_install --user` or
|
||||||
|
`pip install --user`.
|
||||||
|
|
||||||
|
virtualenvwrapper
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
[virtualenvwrapper][2] is a frontend to the popular [virtualenv][3] utility.
|
||||||
|
|
||||||
|
virtualenv creates isolated Python environments and virtualenvwrapper provides
|
||||||
|
convenient shell functions to create, switch, and manage them.
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
|
||||||
|
Install virtualenvwrapper and set [`$WORKON_HOME`][4] to the path where virtual
|
||||||
|
environments will be stored.
|
||||||
|
|
||||||
|
Authors
|
||||||
|
-------
|
||||||
|
|
||||||
|
*The authors of this module should be contacted via the GitHub issue tracker.*
|
||||||
|
|
||||||
|
- [Sorin Ionescu](/sorin-ionescu)
|
||||||
|
- [Sebastian Wiesner](/lunaryorn)
|
||||||
|
|
||||||
|
[1]: http://www.python.org/dev/peps/pep-0370/
|
||||||
|
[2]: http://www.doughellmann.com/projects/virtualenvwrapper/
|
||||||
|
[3]: http://pypi.python.org/pypi/virtualenv
|
||||||
|
[4]: http://www.doughellmann.com/docs/virtualenvwrapper/#introduction
|
||||||
|
|
Loading…
Reference in a new issue