pollin-tool 0.2.0

CLI tool for static site generation from GAMS5 digital object collections

Poll-In tool

CLI tool that polls / pulls-in ("poll-in") digital objects from a GAMS5 project and performs static site rendering. (Informatics: polling-concept) Supplies a development workflow for GAMS5-based web projects.

Meant as replacement for the gams3 "gamsdev" development workflow.

Quickstart

1. Setup project files for the pollin tool

2. Install pollin-tool itself

# 1. install uv
# mac might need brew to install uv

# 2. install pollin-tool via 
# optionally specifiy version tag
uv tool install pollin-tool

# verify installation via
pollin --version

# 3. use the pollin-tool
cd ./my/working/directory
pollin dev # will use the pollin.toml from the current working dir
# alternatively specifiy a path
pollin dev "C:\path\to\project"
# check for basic commands
pollin 

Basic usage

1. Have a running GAM5-API (OR external)
2. Clone or init project files
3. UV setup (install via pypi or clone via git)

# 01. Setup project files from templates: https://zimlab.uni-graz.at/gams5/projects/project_template/gams-www
# 01b. Install uv (python package)

# 02a. Install via pypi
# 02a. uv install / pip install

# 02b. Clone pollin-tool
# 02b. uv sync (uv procedure)
# 02b. Start virtual environment (venv)

# 03. Configure pollin tool via config file (pollin.toml) in template project folder

# (point to project folder with config file)
pollin dev "C:\path\to\project"

# for production use
pollin build "C:\path\to\project"

Staging

pollin stage "/path/to/project"

Production

# use build command to generate the production files
pollin build "/path/to/project"

Deployment

• use the -d flag to deploy to staging or production environment

# staging deployment
pollin stage "/path/to/project" -d

# production deployment
pollin build "/path/to/project" -d

Development

Release

1. Increment version in pyproject.toml in feature branch (merging into develop):
   • make sure version follow vd.d.d pattern
2. Merge changes to develop -> main
3. Create release on the gitlab webclient (from main branch) with new git tag that must be the same as in the pyproject.toml!
   • e.g. v0.1.1
   • create the release from the main branch!
   • gitlab will autodeploy the new version to pypi