prezto/modules/python/README.md

Python
======

Enables local Python and local Python package installation.

Local Python Installation
-------------------------

[pythonz][4] builds and installs multiple Python versions locally in the home
directory.

This module prepends the pythonz directory to the path variable to enable the
execution of `pythonz`.

### Usage

Install Python versions with `pythonz install` into *~/.pythonz/pythons*.

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.

Virtual environments are stored in *~/.virtualenvs*.

There are configuration variables that have to be set to enable certain features.
If you wish to use these features, export the variables in *~/.zshenv*

The variable `$PROJECT_HOME` tells virtualenvwrapper where to place project
working directories. It must be set and the directory created before `mkproject`
is used. Replace *Developer* with your projects directory.

    export PROJECT_HOME="$HOME/Developer"

The variable `$VIRTUALENVWRAPPER_VIRTUALENV_ARGS` tells virtualenvwrapper what
arguments to pass to `virtualenv`. For example, set the value to
*--no-site-packages* to ensure that all new environments are isolated from the
system site-packages directory.

    export VIRTUALENVWRAPPER_VIRTUALENV_ARGS='--no-site-packages'

### Theming

To display the name of the current virtual enviroment in a prompt, define the
following style in the `prompt_theme_setup` function.

    # %v - virtualenv name.
    zstyle ':prezto:module:python' virtualenv 'virtualenv:%v'

Then add `$python_info[virtualenv]` to `$PROMPT` or `$RPROMPT` and call
`python-info` in the `prompt_theme_preexec` hook function.

Aliases
-------

  - `py` is short for `python`.

### Pythonz

  - `pyz` is short for `pythonz`.
  - `pyzc` removes stale source folders and archives.
  - `pyzi` installs Python versions.
  - `pyzl` lists installed Python versions.
  - `pyzL` lists available Python versions.
  - `pyzu` updates itself to the latest version.
  - `pyzx` uninstalls Python versions.

Functions
---------

  - `python-info` exposes information about the Python environment via the
    `$python_info` associative array.

Authors
-------

*The authors of this module should be contacted via the [issue tracker][5].*

  - [Sorin Ionescu](https://github.com/sorin-ionescu)
  - [Sebastian Wiesner](https://github.com/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://saghul.github.com/pythonz/
[5]: https://github.com/sorin-ionescu/prezto/issues