mirror of
https://github.com/daylinmorgan/viv.git
synced 2024-11-09 19:13:14 -06:00
156 lines
5 KiB
Markdown
156 lines
5 KiB
Markdown
<!-- badges -->
|
|
[![Stargazers][stars-shield]][stars-url]
|
|
[![Issues][issues-shield]][issues-url]
|
|
[![MIT License][license-shield]][license-url]
|
|
[![PYPI][pypi-shield]][pypi-url]
|
|
[](https://github.com/astral-sh/ruff)
|
|
[](https://github.com/psf/black)
|
|
[](https://pre-commit.com)
|
|
[![Conda][conda-shield]][conda-url]
|
|
|
|
<div align="center">
|
|
<a href="https://github.com/daylinmorgan/viv">
|
|
<img src="https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/logo.svg" alt="Logo" width=500 >
|
|
</a>
|
|
<p align="center">
|
|
<h1> viv isn't venv </h1>
|
|
</p>
|
|
<div align="center">
|
|
<img
|
|
src="https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/viv-help.svg"
|
|
alt="cli screenshot"
|
|
width="500"
|
|
>
|
|
</div>
|
|
<p align="center">
|
|
<a href="https://viv.dayl.in">Documentation</a>
|
|
</p>
|
|
</div>
|
|
|
|
Try before you buy!
|
|
```sh
|
|
python3 <(curl -fsSL viv.dayl.in/viv.py) run frogmouth -- gh daylinmorgan/viv
|
|
```
|
|
---
|
|
|
|
`Viv` is a standalone dependency-free `venv` creator (just needs python + pip).
|
|
`Viv` helps you ignore silly things like managing temporary or rarely used virtual environments,
|
|
while still unleashing the full power of python scripting with it's entire ecosystem at your disposal.
|
|
|
|
`Viv`'s uncompromising insistence on portability means that it will always,
|
|
only use the standard library and never exceed a single script.
|
|
|
|
See the [documentation](https://viv.dayl.in) or the [examples](https://github.com/daylinmorgan/viv/tree/main/examples) to get started.
|
|
|
|
## Setup
|
|
|
|
Run the below command to install `viv`.
|
|
|
|
```sh
|
|
python3 <(curl -fsSL viv.dayl.in/viv.py) manage install
|
|
```
|
|
|
|
To access `viv` from within scripts you should add its location to your `PYTHONPATH`.
|
|
By default `viv` will be installed to `$XDG_DATA_HOME/viv` or `~/.local/share/viv`;
|
|
you can customize this with `--src`.
|
|
|
|
```sh
|
|
export PYTHONPATH="$PYTHONPATH:$HOME/.local/share/viv"
|
|
```
|
|
|
|
### Pypi (Not Recommended)
|
|
|
|
```sh
|
|
pip install viv
|
|
```
|
|
|
|
Why is this *not recommended?* Mainly because `viv` is all about hacking your `sys.path`.
|
|
Placing it in its own virtual environment or installing in a user site directory may complicate this endeavor.
|
|
|
|
## Usage
|
|
|
|
In any Python script with external dependencies you can add this line
|
|
to automate `vivenv` creation and installation of dependencies.
|
|
|
|
As a cli:
|
|
|
|
```sh
|
|
viv run frogmouth -- gh daylinmorgan/viv
|
|
```
|
|
|
|
As a python module:
|
|
|
|
```python
|
|
__import__("viv").use("click")
|
|
```
|
|
|
|
As an app installer:
|
|
|
|
```sh
|
|
viv shim ruff
|
|
```
|
|
|
|
To remove all `vivenvs` you can use the below command:
|
|
|
|
```sh
|
|
viv env remove $(viv list -q)
|
|
```
|
|
|
|
To remove `viv` altogether you can use the included `purge` command:
|
|
|
|
```sh
|
|
python3 <(curl -fsSL viv.dayl.in/viv.py) manage purge
|
|
```
|
|
|
|
## Equivalent commands from alternatives
|
|
|
|
### [pip-run](https://github.com/jaraco/pip-run)
|
|
|
|
```sh
|
|
pip-run cowsay -- -m cowsay "moove over, pip-run"
|
|
python3 <(curl -fsSL viv.dayl.in/viv.py) run cowsay -- "moove over, pip-run"
|
|
```
|
|
|
|
```sh
|
|
python -m pip-run requests -- -c "import requests; print(requests.get('https://pypi.org/project/pip-run').status_code)"
|
|
python -m viv run requests -b python -- -c "import requests; print(requests.get('https://pypi.org/project/viv').status_code)"
|
|
```
|
|
|
|
### [pipx](https://github.com/pypa/pipx/)
|
|
|
|
```sh
|
|
pipx install pycowsay
|
|
viv shim pycowsay
|
|
```
|
|
|
|
```sh
|
|
pipx run https://gist.githubusercontent.com/cs01/fa721a17a326e551ede048c5088f9e0f/raw/6bdfbb6e9c1132b1c38fdd2f195d4a24c540c324/pipx-demo.py
|
|
python3 <(curl -fsSL viv.dayl.in/viv.py) run \
|
|
-s https://gist.githubusercontent.com/cs01/fa721a17a326e551ede048c5088f9e0f/raw/6bdfbb6e9c1132b1c38fdd2f195d4a24c540c324/pipx-demo.py
|
|
```
|
|
|
|
## Bonus: use `viv` with just standalone snippet (37LOC)
|
|
|
|
`--standalone` will auto-generate a mini-function version of `viv`
|
|
to accomplish the same basic task as using a local copy of `viv`.
|
|
After generating this standalone shim you can freely use this script
|
|
across Unix machines which have Python > 3.8.
|
|
See [examples/black](https://github.com/daylinmorgan/viv/blob/dev/examples/black)
|
|
for output of the below command.
|
|
|
|
`viv freeze` also supports `--standalone`.
|
|
|
|
```sh
|
|
python3 <(curl -fsSL viv.dayl.in/viv.py) shim black -o ./black --standalone --freeze
|
|
```
|
|
|
|
[conda-shield]: https://img.shields.io/conda/vn/conda-forge/viv
|
|
[conda-url]: https://anaconda.org/conda-forge/viv
|
|
[pypi-shield]: https://img.shields.io/pypi/v/viv
|
|
[pypi-url]: https://pypi.org/project/viv
|
|
[stars-shield]: https://img.shields.io/github/stars/daylinmorgan/viv.svg
|
|
[stars-url]: https://github.com/daylinmorgan/viv/stargazers
|
|
[issues-shield]: https://img.shields.io/github/issues/daylinmorgan/viv.svg
|
|
[issues-url]: https://github.com/daylinmorgan/viv/issues
|
|
[license-shield]: https://img.shields.io/github/license/daylinmorgan/viv.svg
|
|
[license-url]: https://github.com/daylinmorgan/viv/blob/main/LICENSE
|