diff --git a/plugins/python/README.md b/plugins/python/README.md new file mode 100644 index 000000000..2d955c5cb --- /dev/null +++ b/plugins/python/README.md @@ -0,0 +1,16 @@ +# 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 ` | Looks for `text` in .py files |