pygen-scaffold

A python program for scaffolding python projects.

Setup

Step 1. Create a virtual environment

You only need to do this once, if you've done it before for this project, you can skip this step.

python3 -m venv venv

Step 2. Activate the virtual environment

source venv/bin/activate

Step 3. Upgrade PIP

pip install --upgrade pip

Step 4. Install the dependencies

# Install the production dependencies
pip install -r requirements.txt

# Install development dependencies
pip install -r requirements-dev.txt

Development Usage

Clean transient files

inv clean

Run the tests

inv test

Generate Coverage Report

inv coverage

Run the linter

inv lint

Execute the build process

inv

References

Github-flavored Markdown