LitePolis-database-particiapi

ParticiAPI-compatible database module for LitePolis. This module extends LitePolis-database-default with ParticiAPI-specific models and functionality.

Overview

This module provides:

• ParticiapiUser - Extended participant model with ParticiAPI fields
• ParticipantExtended - Additional participant metadata
• ParticiapiIssuer - OIDC issuer configuration
• MathMain - Math results caching
• NotificationTasks - Notification queue management

Installation

litepolis-cli deploy add-deps litepolis-database-particiapi
litepolis-cli deploy sync-deps

Configuration

This module shares database configuration with LitePolis-database-default. To customize, create a config file:

litepolis-cli deploy init-config

Then edit ~/.litepolis/litepolis.config:

[litepolis_database_default]
database_url = sqlite:///database.db
# For production:
# database_url = postgresql://user:pass@localhost:5432/litepolis
sqlalchemy_engine_pool_size = 30
sqlalchemy_pool_max_overflow = 50

Or set environment variables:

export DATABASE_URL="postgresql://user:pass@localhost:5432/litepolis"

Models

ParticiapiUser (participants table)

ParticipantExtended (participants_extended table)

Quick Start

1. Install all ParticiAPI modules:

litepolis-cli deploy add-deps litepolis-database-particiapi
litepolis-cli deploy add-deps litepolis-router-particiapi
litepolis-cli deploy add-deps litepolis-ui-particiapp
litepolis-cli deploy sync-deps

2. Start LitePolis server:

litepolis-cli deploy serve

Usage

from litepolis_database_particiapi import DatabaseActor

# Get or create participant
participant = DatabaseActor.get_or_create_participant(zid=1, uid=1)

# Record vote
vote = DatabaseActor.do_vote(zid=1, pid=1, tid=1, vote=1)

# Get statements for conversation
statements = DatabaseActor.get_statements(zid=1)

DatabaseActor Methods

Development Testing

pip install -e .
pytest tests/

Related Modules

• LitePolis-router-particiapi - ParticiAPI router
• LitePolis-ui-particiapp - ParticiApp frontend

License

MIT License