summaryrefslogtreecommitdiff
path: root/plugins/python
diff options
context:
space:
mode:
authorSagar Patil <sagar010797@gmail.com>2018-10-03 03:21:14 +0530
committerMarc Cornellà <marc.cornella@live.com>2018-10-02 23:51:14 +0200
commit0fdb911da0ac6f167c558af129a64211c1a560ee (patch)
treeb531f4df7569627058a287b754a0e6d9cac39e8f /plugins/python
parent3db25d578ac8c0f4c3ca96a4242ba553f561557d (diff)
downloadzsh-0fdb911da0ac6f167c558af129a64211c1a560ee.tar.gz
zsh-0fdb911da0ac6f167c558af129a64211c1a560ee.tar.bz2
zsh-0fdb911da0ac6f167c558af129a64211c1a560ee.zip
python: add README (#7191)
Diffstat (limited to 'plugins/python')
-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 |