daylin/viv
1
0
Fork 0
mirror of https://github.com/daylinmorgan/viv.git synced 2024-12-22 02:30:44 -06:00
Code Issues Projects Releases Packages Wiki Activity

docs: minor changes

Browse source
This commit is contained in:
Daylin Morgan 2024-01-09 01:58:23 -06:00
parent 6357a99189
commit 9d237d3b96
Signed by: daylin
GPG key ID: C1E52E7DD81DF79F
2 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/configuration.md
View file

@ -6,7 +6,7 @@
: **ephemeral** (default): : **ephemeral** (default):
: `viv run` will generate a temporary directory that is removed following execution : `viv run` will generate a temporary directory that is removed following execution
: **semi-ephemeral** : **semi-ephemeral**
: `viv run` will set the `VIV_CACHE` the directory to `$TEMPDIR/viv-ephemeral-cache-$USER` : `viv run` will set the `VIV_CACHE` directory to `$TEMPDIR/viv-ephemeral-cache-$USER`
: persist : persist
: `viv run` will always use the standard `VIV_CACHE` which maximizes reusable vivenvs : `viv run` will always use the standard `VIV_CACHE` which maximizes reusable vivenvs
@ -14,7 +14,7 @@
: Path to use for vivenv cache by default `$XDG_CACHE_HOME/viv` or `$HOME/.cache/viv` : Path to use for vivenv cache by default `$XDG_CACHE_HOME/viv` or `$HOME/.cache/viv`
`VIV_LOG_PATH` `VIV_LOG_PATH`
: Path to use log file by default `$XDG_DATA_HOME/viv/viv.log` or `$HOME/.local/share/viv/viv.log` : Path to use for log file by default `$XDG_DATA_HOME/viv/viv.log` or `$HOME/.local/share/viv/viv.log`
`VIV_BIN_DIR` `VIV_BIN_DIR`
: Path to use for shims by default `$HOME/.local/bin` : Path to use for shims by default `$HOME/.local/bin`
@ -22,7 +22,7 @@
`VIV_NO_SETUPTOOLS` `VIV_NO_SETUPTOOLS`
: Don't add setuptools to generated vivenvs. : Don't add setuptools to generated vivenvs.
: Many legacy packages expect setuptools to be available : Many legacy packages expect setuptools to be available
and don't appropriate declare it as dependency. and don't appropriately declare it as a dependency.
To minimize frustration `setuptools` is added to every dependency To minimize frustration `setuptools` is added to every dependency
list. list.

26
docs/usage.md
View file

@ -3,10 +3,10 @@
Viv works by ensuring scripts or a given Viv works by ensuring scripts or a given
command are run in an appropriate environment with all specified dependencies. command are run in an appropriate environment with all specified dependencies.
```{tip} :::{tip}
`viv` is a single script and available at viv.dayl.in/viv.py `viv` is a single script and available at `viv.dayl.in/viv.py`
meaning every instance of `viv` in these examples could be `python3 <(curl -fsSL viv.dayl.in/viv.py)` meaning every instance of `viv` in these examples could be `python3 <(curl -fsSL viv.dayl.in/viv.py)`
``` :::
## Run CLI Apps ## Run CLI Apps
@ -16,7 +16,7 @@ Run a python app that provides an entrypoint and separate args with `--`:
viv run frogmouth -- gh daylinmorgan/viv viv run frogmouth -- gh daylinmorgan/viv
``` ```
To run a python module use the `-b/--bin` flag and specify `python`: Run a python module use the `-b/--bin` flag and specify `python`:
```sh ```sh
viv run rich -b python -- -m rich viv run rich -b python -- -m rich
@ -79,13 +79,13 @@ invoke it with embedded metadata thanks to shebangs:
# /// # ///
``` ```
```{note} :::{note}
If using a shebang on a python script `-s/--script` must be the last argument If using a shebang on a python script `-s/--script` must be the last argument
``` :::
```{seealso} :::{seealso}
Check out [PEP723](https://peps.python.org/pep-0723/) for more info about inline script metadata. Check out [PEP723](https://peps.python.org/pep-0723/) for more info about inline script metadata.
``` :::
In any python script with external dependencies you can also add this line prior to imports In any python script with external dependencies you can also add this line prior to imports
to automate `vivenv` creation and installation of dependencies. to automate `vivenv` creation and installation of dependencies.
@ -146,10 +146,10 @@ viv env remove d4b342b3
To get more information about vivenvs you can use `viv list --verbose` or `viv env info <hash>` To get more information about vivenvs you can use `viv list --verbose` or `viv env info <hash>`
```{note} :::{note}
For commands that expect a vivenv hash/name you can use as few characters as you For commands that expect a vivenv hash/name you can use as few characters as you
as you like and `viv` will match it against the existing vivenvs in the cache. as you like and `viv` will match it against the existing vivenvs in the cache.
``` :::
You can list vivenvs given a criteria using `--filter` for example: You can list vivenvs given a criteria using `--filter` for example:
@ -168,13 +168,13 @@ Or no files:
viv list --filter "files:None" viv list --filter "files:None"
``` ```
```{note} :::{note}
`--filter "files:None"` will also apply to vivenvs `--filter "files:None"` will also apply to vivenvs
in which the original file is no longer on the disk in which the original file is no longer on the disk
``` :::
The available filtering criteria are `accessed-after`, The available filtering criteria are `accessed-after`,
`accessed-before`, `created-before`, `created-after`, and `files`. `accessed-before`, `created-before`, `created-after`, `spec` and `files`.
To remove all `vivenvs` you can use the below command: To remove all `vivenvs` you can use the below command: