ohmyzsh/plugins/python/README.md
Petr Bělohlávek 6b54302b90 python: add alias to run the proper IPython based on virtualenv
Current state: a user invokes `ipython` and is provided with the IPython
instance regarding the `$PATH`.

Proposed state: a user invokes `ipython` (which is a new alias in the
*python plugin*) and is provided with the proper IPython instance regarding
the currently activated virtualenv.

Example: the user's default Python is 2.7 with installed IPython 2.7. User
activates Python 3.5 virtualenv where he installs IPython 3.5. After
activating the environment, one expects `ipython` to run the version 3.5,
which does not happen by default. Instead, IPython 2.7 is used, which in
counter-intuitive and often causes problem.

Closes #5797
2020-02-27 17:17:01 +01:00

18 lines
830 B
Markdown

# 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:
```
plugins=(... python)
```
## Aliases
| Command | Description |
|------------------|---------------------------------------------------------------------------------|
| `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 |
| `ipython` | Runs the appropriate `ipython` version according to the activated virtualenv |