https://github.com/jnoortheen/xontrib-avox-poetry

auto-activate venv as one cd into a poetry project
https://github.com/jnoortheen/xontrib-avox-poetry

xonsh xontrib

Last synced: 2 months ago
JSON representation

auto-activate venv as one cd into a poetry project

• Host: GitHub
• URL: https://github.com/jnoortheen/xontrib-avox-poetry
• Owner: jnoortheen
• License: mit
• Created: 2020-12-16T21:49:29.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-11-08T06:31:38.000Z (about 2 years ago)
• Last Synced: 2024-09-08T12:08:30.810Z (3 months ago)
• Topics: xonsh, xontrib
• Language: Python
• Homepage:
• Size: 60.5 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-xontribs - avox_poetry - auto-activate venv as one cd into a poetry project folder. Activate `.venv` inside the project folder is also supported. (Python virtual-environment management)

README

        
# Overview

auto-activate venv as one cd into a poetry project folder. 

## Installation

To install use pip:

``` bash

xpip install xontrib-avox-poetry

# or: xpip install -U git+https://github.com/jnoortheen/xontrib-avox-poetry

```

## Usage

``` bash

xontrib load avox_poetry

```

## Configuration

```python

# If found, the env name is searched inside the $VIRTUALENV_HOME 

# rather than invoking `poetry env info -p` command every time `cd` happens

# It is faster setting this variable. It will also be used by poetry.

$VIRTUALENV_HOME = "~/.virtualenvs"

# name of the venv folder. If found will activate it.

# if set to None then local folder activation will not work.

$XSH_AVOX_VENV_NAME = ".venv"

# exclude activation of certain paths by setting

$XSH_AVOX_EXCLUDED_PATHS = {"xsh-src"}

```

## Credits

This package was created with [xontrib cookiecutter template](https://github.com/jnoortheen/xontrib-cookiecutter).