zpy
is a set of Zsh functions
wrapping
pip-tools
and Python's venv module (or uv),
for the simple and interactive management of
Python virtual environments,
dependency specifications,
and isolated Python app installations.
None of them should get in your way. All have thorough tab completion.
They can generally replace pipenv, poetry, pipx, pipsi, virtualenvwrapper, etc.
The short version of installation:
- Install Python, Zsh, fzf
- Source this repo's
zpy.plugin.zsh
in your.zshrc
, or use a Zsh plugin manager to addandydecleyre/zpy
Check out zpy.rtfd.io for installation, explanation, and usage docs!
Install tools from PyPI or git, each with its own isolated venv:
% pipz install uv tldr jello rich-cli yt-dlp 'visidata @ git+https://github.com/saulpw/visidata@develop'
Create a venv for the current folder (if necessary), activate it, and sync installed pkgs to match all
requirements.txt
lockfiles:% envin
. . . or sync packages to particular lockfiles:
% envin dev-requirements.txt
Add a pkg to
requirements.in
, compile a locked dep tree asrequirements.txt
, and sync installed packages:% pipacs beautifulsoup4
Compile all
(*-)requirements.in
files, upgrading versions where possible, then sync to match:% pipcs -U
Inject "loose" requirements (as written in
requirements.in
) intopyproject.toml
:% pypc
There are about 25 user-facing functions in total. For details, see the reference and the short guide.
They are also available as subcommands to the "supercommand" zpy
;
envin
is equivalent to zpy envin
, etc.
Basic usage of envin
and pipacs
:
Basic usage of pipz
:
Try it in isolation with docker or podman with one of these commands:
$ docker run --net=host -it --rm -e TERM=$TERM quay.io/andykluger/zpy-ubuntu:master
$ podman run --net=host -it --rm -e TERM=$TERM quay.io/andykluger/zpy-ubuntu:master
Replace "ubuntu" with "alpine" or "fedora" if you prefer.
- You should not have to manually specify the dependencies anywhere other than
*requirements.in
files - Folks who want to use your code shouldn't have to install any new-fangled
less-standard tools (pipenv, poetry, pip-tools, zpy, etc.);
pip install -r *requirements.txt
ought to be sufficient - It's nice to keep the venv folder outside of the project itself
- Not every manageable project needs a
pyproject.toml
or to be packaged - Lockfiles are good
- Tab completion is wonderful
- These functions don't: