Metadata-Version: 2.1
Name: xontrib-uvox
Version: 0.0.4
Summary: Python virtual environment manager for xonsh.
Author-email: "L. Grobol" <loic.grobol@gmail.com>
License: Licence
        =======
        
        Copyright © 2023, xontrib-vox
        Copyright © 2024, L. Grobol
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/LoicGrobol/xontrib-uvox
Project-URL: Documentation, https://github.com/LoicGrobol/xontrib-uvox/blob/main/README.md
Project-URL: Code, https://github.com/LoicGrobol/xontrib-uvox
Project-URL: Issue tracker, https://github.com/LoicGrobol/xontrib-uvox/issues
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Shells
Classifier: Topic :: System :: System Shells
Classifier: Topic :: Terminals
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENCE.md
Requires-Dist: xonsh>=0.12.5
Requires-Dist: uv
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-subprocess; extra == "dev"

UVox
====

A [uv](https://github.com/astral-sh/uv)-based Python virtual environment manager for the xonsh shell.

## Installation

To install use pip:

```bash
xpip install xontrib-uvox
```

## Usage

This package contains two xontribs:

- `uvox` - Python virtual environment manager for xonsh.
- `uvoxapi` - API for Uvox

### uvox

Python virtual environment manager for xonsh.

```bash
xontrib load uvox
uvox --help
```

### uvoxapi

```bash
xontrib load uvoxapi
```

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

* `uvox_on_create(env: str) -> None`
* `uvox_on_activate(env: str, path: pathlib.Path) -> None`
* `uvox_on_deactivate(env: str, path: pathlib.Path) -> None`
* `uvox_on_delete(env: str) -> None`


## Credits

This package is a fork of [xontrib-vox](https://github.com/xonsh/xontrib-vox).
