SGELT: Site GEnerator for Labs and Teams

Installation

• Create a python virtual environment :

virtualenv .venv/

• Activate it

source .venv/bin/activate

• Install the package and its dependencies :

pip install sgelt

Build a website

Files organization

• config.yml describes the site configuration
• content/ dir contains markdown files
• agenda.json contains all events data
• teams.json contains teams data

Edit content

• setup configuration in config.yml
• edit content/ dir.
• generate json data files

Build and serve

To build all site files, run :

sgelt

in the project directory. Output files will be written in output/ dir.

Build and serve

To serve the website and rebuild automatically when the content has changed:

sgelt -a -s

To open the homepage in a web browser, add:

sgelt -a -s -b

Get help with CLI

sgelt -h

Tests

Run tests using tox

Tox setup the appropriate environments and run tests using pytest:

pip install tox  # install tox
tox  # run

Run tests using pytest

pip install -e .[tests]  # install dependencies for tests
pytest -sv tests/  # run tests