2021-12-31 00:55:01 -07:00
|
|
|
# Python plugin
|
2018-10-02 14:51:14 -07:00
|
|
|
|
2021-12-31 00:55:01 -07:00
|
|
|
The plugin adds several aliases for useful [Python](https://www.python.org/) commands.
|
2018-10-02 14:51:14 -07:00
|
|
|
|
2021-12-31 00:55:01 -07:00
|
|
|
To use it, add `python` to the plugins array in your zshrc file:
|
2021-09-24 13:37:09 -07:00
|
|
|
|
|
|
|
|
```zsh
|
2018-10-02 14:51:14 -07:00
|
|
|
plugins=(... python)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Aliases
|
|
|
|
|
|
2021-12-31 00:55:01 -07:00
|
|
|
| Command | Description |
|
|
|
|
|
| ---------------- | -------------------------------------------------------------------------------------- |
|
2022-04-09 05:45:42 -07:00
|
|
|
| `py` | Runs `python3` |
|
2021-12-31 00:55:01 -07:00
|
|
|
| `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) |
|
2021-04-01 14:35:00 -07:00
|
|
|
|
|
|
|
|
## 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.
|
