Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/astraluma/xontrib-avox

autovox policy based on project directories
https://github.com/astraluma/xontrib-avox

virtualenv xonsh xontrib

Last synced: 28 days ago
JSON representation

autovox policy based on project directories

Awesome Lists containing this project

README

        

# xontrib-avox
Xontrib for Xonsh that automatically activates and deactivates virtual environments as you `cd` around. It's based on the idea of projects and projects living in specific directories.

For example, if you've set `$PROJECT_DIRS = [p"~/code"]` and have the project directory `~/code/spam`, avox will use the venv name `spam`.


## Installation
Just do a
```console
pip install xontrib-avox
```

or you can clone the repo with pip
```console
pip install git+https://github.com/AstraLuma/xontrib-avox
```

## Configuration
It's required to configure `$PROJECT_DIRS`:
```console
$PROJECT_DIRS = ["~/code"]
```

To automatically load avox at startup, put
```console
xontrib load autovox avox
```

in your `.xonshrc`

Avox respects `$VIRTUALENV_HOME`.