dcarrillo/prezto
1
0
Fork 0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-12-22 18:38:00 +00:00
Code Issues Releases Wiki Activity

[python] cleanup readme formatting

Browse Source 
Anyone want some backticks? :-)
This commit is contained in:
Jeff Widman 2017-08-29 16:47:06 -07:00
parent 8fa14ed72f
commit 727f094b0f
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
modules/python/README.md
View File

@ -14,7 +14,7 @@ execution of `pyenv`.
### Usage ### Usage
Install Python versions with `pyenv install` into *~/.pyenv/versions*. Install Python versions with `pyenv install` into `~/.pyenv/versions`.
Local Package Installation Local Package Installation
-------------------------- --------------------------
@ -33,21 +33,21 @@ Install packages into the per user site directory with `pip install --user`.
virtualenvwrapper virtualenvwrapper
----------------- -----------------
[virtualenvwrapper][2] is a frontend to the popular [virtualenv][3] utility. [`virtualenvwrapper`][2] is a frontend to the popular [`virtualenv`][3] utility.
virtualenv creates isolated Python environments and virtualenvwrapper provides `virtualenv` creates isolated Python environments and `virtualenvwrapper` provides
convenient shell functions to create, switch, and manage them. convenient shell functions to create, switch, and manage them.
### Usage ### Usage
Install virtualenvwrapper. Install `virtualenvwrapper`.
Virtual environments are stored in *~/.virtualenvs*. Virtual environments are stored in `~/.virtualenvs`.
There are configuration variables that have to be set to enable certain features. 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* If you wish to use these features, export the variables in [`zshenv`][6].
The variable `$PROJECT_HOME` tells virtualenvwrapper where to place project The variable `$PROJECT_HOME` tells `virtualenvwrapper` where to place project
working directories. It must be set and the directory created before `mkproject` working directories. It must be set and the directory created before `mkproject`
is used. Replace *Developer* with your projects directory. is used. Replace *Developer* with your projects directory.
@ -55,23 +55,23 @@ is used. Replace *Developer* with your projects directory.
export PROJECT_HOME="$HOME/Developer" export PROJECT_HOME="$HOME/Developer"
``` ```
The variable `VIRTUALENVWRAPPER_PYTHON` tells virtualenvwrapper to use the The variable `VIRTUALENVWRAPPER_PYTHON` tells `virtualenvwrapper` to use the
specified full path of `python` interpreter overriding the `$PATH` search. specified full path of the `python` interpreter overriding the `$PATH` search.
```sh ```sh
export VIRTUALENVWRAPPER_PYTHON=/usr/local/bin/python export VIRTUALENVWRAPPER_PYTHON=/usr/local/bin/python
``` ```
The variable `VIRTUALENVWRAPPER_VIRTUALENV` tells virtualenvwrapper to use the The variable `VIRTUALENVWRAPPER_VIRTUALENV` tells `virtualenvwrapper` to use the
specified full path of `virtualenv` binary overriding the `$PATH` search. specified full path of `virtualenv` binary overriding the `$PATH` search.
```sh ```sh
export VIRTUALENVWRAPPER_VIRTUALENV=/usr/local/bin/virtualenv export VIRTUALENVWRAPPER_VIRTUALENV=/usr/local/bin/virtualenv
``` ```
The variable `$VIRTUALENVWRAPPER_VIRTUALENV_ARGS` tells virtualenvwrapper what The variable `$VIRTUALENVWRAPPER_VIRTUALENV_ARGS` tells `virtualenvwrapper` what
arguments to pass to `virtualenv`. For example, set the value to arguments to pass to `virtualenv`. For example, set the value to
*--system-site-packages* to ensure that all new environments have access to the `--system-site-packages` to ensure that all new environments have access to the
system site-packages directory. system site-packages directory.
```sh ```sh
@ -89,7 +89,7 @@ This can be enabled with:
zstyle ':prezto:module:python:virtualenv' auto-switch 'yes' zstyle ':prezto:module:python:virtualenv' auto-switch 'yes'
``` ```
virtualenvwrapper is automatically initialized if pre-requisites are met `virtualenvwrapper` is automatically initialized if pre-requisites are met
(`$VIRTUALENVWRAPPER_VIRTUALENV` is explicitly set or `virtualenv` is in (`$VIRTUALENVWRAPPER_VIRTUALENV` is explicitly set or `virtualenv` is in
`$PATH`). This can be disabled with: `$PATH`). This can be disabled with:
@ -135,3 +135,4 @@ Authors
[3]: http://pypi.python.org/pypi/virtualenv [3]: http://pypi.python.org/pypi/virtualenv
[4]: https://github.com/yyuu/pyenv [4]: https://github.com/yyuu/pyenv
[5]: https://github.com/sorin-ionescu/prezto/issues [5]: https://github.com/sorin-ionescu/prezto/issues
[6]: https://github.com/sorin-ionescu/prezto/blob/master/runcoms/zshenv