add more general readme info

This commit is contained in:
Daylin Morgan 2022-12-19 23:17:43 -06:00
parent 3b3d33ba9f
commit 97bcf2ee28

View file

@ -1 +1,33 @@
# Viv isn't venv # Viv isn't venv
## Setup
Place this directory on the python path in your rc file.
```sh
export PYTHONPATH="$PYTHONPATH:$HOME/.viv/src"
```
Then in any python script with external dependencies you can add this line.
```python
__import__("viv").activate("click")
```
## Usage
To temove all viv venvs:
```sh
viv remove $(viv list -q)
```
## TODO
- [ ] add doc strings to `src/viv.py`
- [ ] use config file (probably ini or json / could also allow toml for python>=3.11)
- [ ] enable a garbage collection based on time or file existence (configurable)
- [ ] unit tests
## Alternatives
- `pipx`
- `pip-run`