stow/oh-my-zsh/.oh-my-zsh/plugins/python/README.md

   1 # Python plugin
   2
   3 The plugin adds several aliases for useful [Python](https://www.python.org/) commands.
   4
   5 To use it, add `python` to the plugins array in your zshrc file:
   6
   7 ```zsh
   8 plugins=(... python)
   9 ```
  10
  11 ## Aliases
  12
  13 | Command          | Description                                                                            |
  14 | ---------------- | -------------------------------------------------------------------------------------- |
  15 | `py`             | Runs `python3`                                                                         |
  16 | `ipython`        | Runs the appropriate `ipython` version according to the activated virtualenv           |
  17 | `pyfind`         | Finds .py files recursively in the current directory                                   |
  18 | `pyclean [dirs]` | Deletes byte-code and cache files from a list of directories or the current one        |
  19 | `pygrep <text>`  | Looks for `text` in `*.py` files in the current directory, recursively                 |
  20 | `pyuserpaths`    | Add user site-packages folders to `PYTHONPATH`, for Python 2 and 3                     |
  21 | `pyserver`       | Starts an HTTP server on the current directory (use `--directory` for a different one) |
  22
  23 ## Virtual environments
  24
  25 The plugin provides two utilities to manage Python venvs:
  26
  27 - `mkv [name]`: make a new virtual environment called `name` (default: `venv`) in current directory.
  28
  29 - `vrun [name]`: activate virtual environment called `name` (default: `venv`) in current directory.