Getting started

Installing on the System Python

Download the source (or clone the repository) to your computer
Open a terminal in the directory of the source
Install with setup.py
On Mac or Linux:
```
python3 setup.py install
```
On Windows:
```
py setup.py install
```

Setting up a Development Environment

Create a new Python 3 virtual environment
On Mac or Linux:
```
python3 -m venv venv
```
On Windows:
```
py -m venv venv
```
Activate Python virtual environment
On Mac or Linux:
```
source venv/bin/activate
```
On Windows:
```
venv/Scripts/activate
```
Install the grabbags in development mode
```
python -m pip install -e .
```
Start hacking

Building the documentation

1. Follow the instructions above and install and activate the development virtual environment

Install sphinx
```
python -m pip install sphinx
```
Run sphinx build target from setup.py
```
python setup.py build_sphinx
```

By default, the documentation is generated into build/sphinx/html