Skip to content

xonsh/xontrib-vox

Repository files navigation

Python virtual environment manager for xonsh shell.

If you like the idea click ⭐ on the repo and tweet.

Installation

To install use pip:

xpip install xontrib-vox
# or: xpip install -U git+https://github.com/xonsh/xontrib-vox

Usage

This package contains three xontribs:

  • vox - Python virtual environment manager for xonsh.
  • autovox - Manages automatic activation of virtual environments.
  • voxapi - API for Vox, the Python virtual environment manager for xonsh.

vox

Python virtual environment manager for xonsh.

xontrib load vox
vox --help

autovox

Manages automatic activation of virtual environments.

xontrib load autovox

This coordinates multiple automatic vox policies and deals with some of the mechanics of venv searching and chdir handling.

This provides no interface for end users.

Developers should look at XSH.builtins.events.autovox_policy

voxapi

API for Vox, the Python virtual environment manager for xonsh.

xontrib load voxapi

Vox defines several events related to the life cycle of virtual environments:

  • vox_on_create(env: str) -> None
  • vox_on_activate(env: str, path: pathlib.Path) -> None
  • vox_on_deactivate(env: str, path: pathlib.Path) -> None
  • vox_on_delete(env: str) -> None

Credits

This package was created with xontrib template.