Metadata-Version: 2.1
Name: xontrib-avox-poetry
Version: 0.3.2
Summary: auto-activate venv as one cd into a poetry project
Home-page: https://github.com/jnoortheen/xontrib-avox-poetry
License: MIT
Keywords: xontrib,xonsh
Author: Noortheen Raja NJ
Author-email: jnoortheen@gmail.com
Requires-Python: >=3.8
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: System :: Shells
Classifier: Topic :: System :: System Shells
Classifier: Topic :: Terminals
Requires-Dist: tomli
Requires-Dist: xonsh (>=0.12.5)
Project-URL: Code, https://github.com/jnoortheen/xontrib-avox-poetry
Project-URL: Documentation, https://github.com/jnoortheen/xontrib-avox-poetry/blob/master/README.md
Project-URL: Issue tracker, https://github.com/jnoortheen/xontrib-avox-poetry/issues
Project-URL: Repository, https://github.com/jnoortheen/xontrib-avox-poetry
Description-Content-Type: text/markdown

# 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).

