Metadata-Version: 2.4
Name: pollin-tool
Version: 0.1.0
Summary: CLI tool for static site generation from GAMS5 digital object collections
Project-URL: Repository, https://zimlab.uni-graz.at/gams5/pollin
Author-email: Sebastian Schiller-Stoff <sebastian.stoff@uni-graz.at>
License: MIT
License-File: LICENSE.md
Keywords: digital-humanities,gams,jinja2,static-site-generator
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Requires-Python: >=3.12
Requires-Dist: aiohttp>=3.13.3
Requires-Dist: click>=8.3.1
Requires-Dist: jinja2==3.1.6
Requires-Dist: requests>=2.32.4
Requires-Dist: watchdog>=6.0.0
Description-Content-Type: text/markdown

# 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.

## Basic usage

0. Have a running GAM5-API (OR external)
1. Clone or init project files
2. UV setup


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

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

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

# 04. Use pollin tool from venv for development
# (point to project folder with config file)
pollin dev "C:\path\to\project"

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

```

## Staging

```sh
pollin stage "/path/to/project"

```


## Production

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

```


## Deployment

- use the -d flag to deploy to staging or production envrionment

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

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


```