SGELT: Site GEnerator for Labs and Teams
Project description
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 --index-url https://gitlab.math.unistra.fr/api/v4/projects/653/packages/pypi/simple
Build a website
Files organization
config.yml
describes the site configurationcontent/
dir contains markdown filesagenda.json
contains all events datateams.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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sgelt-4.8.2.tar.gz
(439.0 kB
view hashes)
Built Distribution
sgelt-4.8.2-py3-none-any.whl
(427.5 kB
view hashes)