From e54128312638b10c6710a538894fea921d248c19 Mon Sep 17 00:00:00 2001 From: Sorin Ionescu Date: Sat, 5 May 2012 13:15:44 -0400 Subject: [PATCH] [Fix #112] Add documentation for python --- modules/python/README.md | 45 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 modules/python/README.md diff --git a/modules/python/README.md b/modules/python/README.md new file mode 100644 index 00000000..6c39578c --- /dev/null +++ b/modules/python/README.md @@ -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 +