mirror of
https://github.com/daylinmorgan/viv.git
synced 2024-09-19 11:37:18 -05:00
135 lines
4.1 KiB
Markdown
135 lines
4.1 KiB
Markdown
<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/docs/svgs/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 pycowsay -- "viv isn't venv\!"
|
|
```
|
|
---
|
|
|
|
`Viv` is a standalone dependency-free `venv` creator [^1].
|
|
`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:
|
|
|
|
1. only use the standard library
|
|
2. never exceed a single script.
|
|
|
|
For that reason any usage of the `cli` can be accomplished using a remote copy as seen in the below install command.
|
|
|
|
Currently, the project is in alpha and in particular the `cli` is under active development and is subject to change.
|
|
The basic feature set surrounding virtual environment/dependency management should remain stable however.
|
|
|
|
## 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 it's 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 it's 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.
|
|
|
|
```python
|
|
__import__("viv").use("click")
|
|
```
|
|
|
|
To remove all `vivenvs` you can use the below command:
|
|
|
|
```sh
|
|
viv remove $(viv list -q)
|
|
```
|
|
|
|
To remove `viv` all together you can use the included `purge` command:
|
|
|
|
```sh
|
|
python3 <(curl -fsSL viv.dayl.in/viv.py) manage purge
|
|
```
|
|
|
|
## Additional Features
|
|
|
|
An experimental feature of `viv` is generating shim's that leverage the principles of `viv`.
|
|
These shims would operate similar to `pipx` in which you can specify a command line app to "install".
|
|
|
|
*Note* that `--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 below command.
|
|
|
|
```sh
|
|
python3 <(curl -fsSL viv.dayl.in/viv.py) shim black -o ./black --standalone --freeze
|
|
```
|
|
|
|
## Alternatives
|
|
|
|
### [pip-run](https://github.com/jaraco/pip-run)
|
|
|
|
```sh
|
|
pip-run (10.0.5)
|
|
├── autocommand (2.2.2)
|
|
├── jaraco-context (4.3.0)
|
|
├── jaraco-functools (3.6.0)
|
|
│ └── more-itertools (9.1.0)
|
|
├── jaraco-text (3.11.1)
|
|
│ ├── autocommand (2.2.2)
|
|
│ ├── inflect (6.0.2)
|
|
│ │ └── pydantic>=1.9.1 (1.10.5)
|
|
│ │ └── typing-extensions>=4.2.0 (4.5.0)
|
|
│ ├── jaraco-context>=4.1 (4.3.0)
|
|
│ ├── jaraco-functools (3.6.0)
|
|
│ │ └── more-itertools (9.1.0)
|
|
│ └── more-itertools (9.1.0)
|
|
├── more-itertools>=8.3 (9.1.0)
|
|
├── packaging (23.0)
|
|
├── path>=15.1 (16.6.0)
|
|
├── pip>=19.3 (23.0.1)
|
|
└── platformdirs (3.1.0)
|
|
```
|
|
|
|
### [pipx](https://github.com/pypa/pipx/)
|
|
|
|
```sh
|
|
pipx (1.1.0)
|
|
├── argcomplete>=1.9.4 (2.1.1)
|
|
├── packaging>=20.0 (23.0)
|
|
└── userpath>=1.6.0 (1.8.0)
|
|
└── click (8.1.3)
|
|
```
|
|
|
|
[^1]: You do need to have `pip` but surely you have `pip` already.
|