diff options
Diffstat (limited to 'plugins/python/README.md')
| -rw-r--r-- | plugins/python/README.md | 34 |
1 files changed, 22 insertions, 12 deletions
diff --git a/plugins/python/README.md b/plugins/python/README.md index b95ffe679..c1f0adef8 100644 --- a/plugins/python/README.md +++ b/plugins/python/README.md @@ -1,19 +1,29 @@ -# python plugin +# Python plugin -The plugin adds several aliases for useful [python](https://www.python.org/) commands. +The plugin adds several aliases for useful [Python](https://www.python.org/) commands. -To use it, add `python` to the plugins array of your zshrc file: -``` +To use it, add `python` to the plugins array in your zshrc file: + +```zsh plugins=(... python) ``` ## Aliases -| Command | Description | -|------------------|---------------------------------------------------------------------------------| -| `py` | Runs `python` | -| `ipython` | Runs the appropriate `ipython` version according to the activated virtualenv | -| `pyfind` | Finds .py files recursively in the current directory | -| `pyclean [dirs]` | Deletes byte-code and cache files from a list of directories or the current one | -| `pygrep <text>` | Looks for `text` in .py files | -| `pyuserpaths` | Add --user site-packages to PYTHONPATH, for all installed python versions. | +| Command | Description | +| ---------------- | -------------------------------------------------------------------------------------- | +| `py` | Runs `python` | +| `ipython` | Runs the appropriate `ipython` version according to the activated virtualenv | +| `pyfind` | Finds .py files recursively in the current directory | +| `pyclean [dirs]` | Deletes byte-code and cache files from a list of directories or the current one | +| `pygrep <text>` | Looks for `text` in `*.py` files in the current directory, recursively | +| `pyuserpaths` | Add user site-packages folders to `PYTHONPATH`, for Python 2 and 3 | +| `pyserver` | Starts an HTTP server on the current directory (use `--directory` for a different one) | + +## Virtual environments + +The plugin provides two utilities to manage Python venvs: + +- `mkv [name]`: make a new virtual environment called `name` (default: `venv`) in current directory. + +- `vrun [name]`: activate virtual environment called `name` (default: `venv`) in current directory. |