summaryrefslogtreecommitdiff
path: root/plugins/python/README.md
diff options
context:
space:
mode:
authorMarijan Smetko <msmetko@ZVIJER-PC.localdomain>2021-04-01 23:35:00 +0200
committerMarc Cornellà <hello@mcornella.com>2021-12-29 15:57:17 +0100
commit02eb548d5ac41c57d37af6817c77dfbb57a8d281 (patch)
treecbdc8fecf9fc050371c0b2f20429e5ed71d7e361 /plugins/python/README.md
parent3e2676f7dcafbec3c8e481e6ebfb2454bd3c232c (diff)
downloadzsh-02eb548d5ac41c57d37af6817c77dfbb57a8d281.tar.gz
zsh-02eb548d5ac41c57d37af6817c77dfbb57a8d281.tar.bz2
zsh-02eb548d5ac41c57d37af6817c77dfbb57a8d281.zip
feat(python): add utilities to manage simple virtual environments (#9776)
Closes #9776
Diffstat (limited to 'plugins/python/README.md')
-rw-r--r--plugins/python/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/plugins/python/README.md b/plugins/python/README.md
index eeaa1148a..4968cca6d 100644
--- a/plugins/python/README.md
+++ b/plugins/python/README.md
@@ -10,6 +10,7 @@ plugins=(... python)
## Aliases
+<<<<<<< HEAD
| Command | Description |
| ---------------- | ------------------------------------------------------------------------------------- |
| `py` | Runs `python` |
@@ -19,3 +20,11 @@ plugins=(... python)
| `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 |
+
+## Virtual environments
+
+The plugin provides two utilities to manage Python venvs:
+
+- `mkv [name]`: make a new virtual environment called `name` (default: `venv`) in current directory.
+
+- `vrun [name]`: activate virtual environment called `name` (default: `venv`) in current directory.