Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xonsh/xontrib-vox
Python virtual environment manager for xonsh.
https://github.com/xonsh/xontrib-vox
python-virtual-environment python-virtualenv xonsh xontrib
Last synced: about 1 month ago
JSON representation
Python virtual environment manager for xonsh.
- Host: GitHub
- URL: https://github.com/xonsh/xontrib-vox
- Owner: xonsh
- License: mit
- Created: 2023-02-14T15:23:33.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T17:56:42.000Z (about 2 months ago)
- Last Synced: 2024-10-22T08:42:42.185Z (about 2 months ago)
- Topics: python-virtual-environment, python-virtualenv, xonsh, xontrib
- Language: Python
- Homepage:
- Size: 32.2 KB
- Stars: 19
- Watchers: 3
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-xontribs - autovox - A framework for automatic vox.\* [voxapi](https://github.com/xonsh/xontrib-vox) - API for vox. (Python virtual-environment management)
README
Python virtual environment manager for xonsh shell.
If you like the idea click ⭐ on the repo and tweet.
## Installation
To install use pip:
```bash
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.
```bash
xontrib load vox
vox --help
```
### autovox
Manages automatic activation of virtual environments.
```bash
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.
```bash
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](https://github.com/xonsh/xontrib-template).