Browse Source

python: add README (#7191)

Sagar Patil 6 years ago
parent
commit
0fdb911da0
1 changed files with 16 additions and 0 deletions
  1. 16 0
      plugins/python/README.md

+ 16 - 0
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                                                   |