summaryrefslogtreecommitdiff
path: root/plugins/python/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/python/README.md')
-rw-r--r--plugins/python/README.md16
1 files changed, 16 insertions, 0 deletions
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 <text>` | Looks for `text` in .py files |