prezto_config/modules/python/README.md

94 lines
2.5 KiB
Markdown
Raw Normal View History

Python
======
2012-09-03 03:14:32 +02:00
Enables local Python and local Python package installation.
Local Python Installation
-------------------------
[pythonz][6] 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].
2012-06-02 23:17:12 +02:00
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.
### 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 ':omz: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.
2012-08-15 14:00:08 +02:00
Aliases
-------
- `py` is short for `python`.
2012-09-03 03:14:32 +02:00
### 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
-------
2012-05-22 02:18:30 +02:00
*The authors of this module should be contacted via the [issue tracker][5].*
2012-05-22 02:18:30 +02:00
- [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://www.doughellmann.com/docs/virtualenvwrapper/#introduction
2012-05-22 02:18:30 +02:00
[5]: https://github.com/sorin-ionescu/oh-my-zsh/issues
2012-09-03 03:14:32 +02:00
[6]: http://saghul.github.com/pythonz/