summaryrefslogtreecommitdiff
path: root/plugins/python/README.md
blob: 4968cca6da17bb1ccf31473d18579bcacbcea3cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# python plugin

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:

```zsh
plugins=(... python)
```

## Aliases

<<<<<<< HEAD
| 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.            |
| `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.