Metadata-Version: 2.1
Name: lagoon
Version: 28
Summary: Concise layer on top of subprocess, similar to sh project
Home-page: https://github.com/combatopera/lagoon
Author: Andrzej Cichocki
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: COPYING

# lagoon
Concise layer on top of subprocess, similar to sh project

## Support
If you see an error along the lines of:
```
ImportError: cannot import name 'zyx' from 'lagoon'
```
This means the app requires command `zyx` to be available, and you don't have it on your system.
The solution is to install `zyx` in the usual way, e.g. via your package manager.

## Install
These are generic installation instructions.

### To use, permanently
The quickest way to get started is to install the current release from PyPI:
```
pip3 install --user lagoon
```

### To use, temporarily
If you prefer to keep .local clean, install to a virtualenv:
```
python3 -m venv venvname
venvname/bin/pip install lagoon
. venvname/bin/activate
```

### To develop
First clone the repo using HTTP or SSH:
```
git clone https://github.com/combatopera/lagoon.git
git clone git@github.com:combatopera/lagoon.git
```
Now use pyven's pipify to create a setup.py, which pip can then use to install the project editably:
```
python3 -m venv pyvenvenv
pyvenvenv/bin/pip install pyven
pyvenvenv/bin/pipify lagoon

python3 -m venv venvname
venvname/bin/pip install -e lagoon
. venvname/bin/activate
```


