summaryrefslogtreecommitdiff
path: root/plugins/python/README.md
diff options
context:
space:
mode:
authorCelestino Gomes <tinorj@gmail.com>2021-09-24 17:37:09 -0300
committerMarc Cornellà <hello@mcornella.com>2021-12-29 15:44:25 +0100
commit3e2676f7dcafbec3c8e481e6ebfb2454bd3c232c (patch)
tree9662474a8186e602409f14a3ff227cb063bde0e5 /plugins/python/README.md
parent4ef188cebf054896b47aa91181dacc2c674b5063 (diff)
downloadzsh-3e2676f7dcafbec3c8e481e6ebfb2454bd3c232c.tar.gz
zsh-3e2676f7dcafbec3c8e481e6ebfb2454bd3c232c.tar.bz2
zsh-3e2676f7dcafbec3c8e481e6ebfb2454bd3c232c.zip
feat(python): add `pyserver` alias to start an HTTP server (#10217)
Closes #10217
Diffstat (limited to 'plugins/python/README.md')
-rw-r--r--plugins/python/README.md20
1 files changed, 11 insertions, 9 deletions
diff --git a/plugins/python/README.md b/plugins/python/README.md
index b95ffe679..eeaa1148a 100644
--- a/plugins/python/README.md
+++ b/plugins/python/README.md
@@ -3,17 +3,19 @@
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:
-```
+
+```zsh
plugins=(... python)
```
## Aliases
-| Command | Description |
-|------------------|---------------------------------------------------------------------------------|
-| `py` | Runs `python` |
-| `ipython` | Runs the appropriate `ipython` version according to the activated virtualenv |
-| `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 |
-| `pyuserpaths` | Add --user site-packages to PYTHONPATH, for all installed python versions. |
+| Command | Description |
+| ---------------- | ------------------------------------------------------------------------------------- |
+| `py` | Runs `python` |
+| `ipython` | Runs the appropriate `ipython` version according to the activated virtualenv |
+| `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 |
+| `pyuserpaths` | Add --user site-packages to PYTHONPATH, for all installed python versions. |
+| `pyserver` | Starts an http.server on the current directory. Use `--directory` for a different one |