daylin
/
viv
mirror of https://github.com/daylinmorgan/viv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: finish updating docs

This commit is contained in:
Daylin Morgan 2024-01-09 01:41:34 -06:00
parent 13cb21435d
commit 032e23af95
Signed by: daylin
GPG Key ID: C1E52E7DD81DF79F
2 changed files with 25 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -44,6 +44,16 @@ while still unleashing the full power of Python scripting with its entire ecosys
For that reason, any usage of the CLI can be accomplished using a remote copy as seen in the below install command.
`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/viv.py) or the [examples](https://github.com/daylinmorgan/viv/tree/main/examples) to get started.
## Setup
Run the below command to install `viv`.
@ -74,10 +84,24 @@ Placing it in its own virtual environment or installing in a user site directory
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
@ -89,11 +113,11 @@ 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"
@ -132,9 +156,6 @@ for output of the below command.
python3 <(curl -fsSL viv.dayl.in/viv.py) shim black -o ./black --standalone --freeze
```
[^1]: You do need to have `pip` but surely you have `pip` already.
[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

1
docs/index.md
View File

@ -26,7 +26,6 @@ while still unleashing the full power of python scripting with it's entire ecosy
`Viv`'s uncompromising insistence on portability means that it will always,
only use the standard library and never exceed a single script.
Documentation is currently a WIP please see the [cli reference](./cli.md) and the [README](https://github.com/daylinmorgan/viv)
```{toctree}
:hidden: