Skip to content

feat(spp_mis_demo_v2): add demo API client and statistics data #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jeremi wants to merge 11 commits into
base: 19.0
Choose a base branch
from
Open

feat(spp_mis_demo_v2): add demo API client and statistics data #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3c02f07
feat(spp_mis_demo_v2): add demo API client and statistics data
jeremi Mar 5, 2026
2252373
fix(spp_mis_demo_v2): add spp_api_v2_gis dependency for demo API client
jeremi Mar 5, 2026
4c3ffb4
feat(spp_mis_demo_v2): add geographic data loading and GIS report ref…
jeremi Mar 5, 2026
7460b9a
fix(spp_mis_demo_v2): address review comments on demo data
jeremi Mar 5, 2026
310f648
style(spp_mis_demo_v2): fix prettier formatting in wizard view XML
jeremi Mar 5, 2026
610f493
fix(spp_mis_demo_v2): use ORM Shapely geometry for coordinate generation
jeremi Mar 5, 2026
c908686
fix: resolve CI pre-commit and dependency failures
jeremi Mar 5, 2026
3a37363
fix: remove remaining PII from log messages
jeremi Mar 5, 2026
8071cba
fix: replace deprecated <data> node with <odoo noupdate="1">
jeremi Mar 5, 2026
2703c1d
style: apply prettier formatting to XML data files
jeremi Mar 5, 2026
aa4db87
fix: remove demo_api_client.xml from data (requires spp_api_v2_gis)
jeremi Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions spp_mis_demo_v2/__manifest__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@
"spp_demo",
# GIS Reports for geographic visualization
"spp_gis_report",
# Registrant GPS coordinates for QGIS plugin demo
"spp_registrant_gis",
# Statistics and aggregation for demo indicators
"spp_statistic",
"spp_aggregation",
"spp_studio",
# NOTE: spp_api_v2_gis (GIS API for QGIS plugin) is a soft dependency.
# Install it separately to activate the 'gis' scopes on the demo API client.
# QR Credentials (Claim 169)
"spp_claim_169",
# Demo-specific extensions
Expand All @@ -38,6 +46,9 @@
"data/change_request_types.xml",
"data/demo_change_requests_ux.xml",
"data/demo_gis_reports.xml",
"data/demo_statistics.xml",
# NOTE: demo_api_client.xml requires spp_api_v2_gis (adds 'gis' resource).
# It is loaded conditionally in the post_init_hook when the module is available.
"views/mis_demo_wizard_view.xml",
],
"assets": {},
Expand Down
47 changes: 47 additions & 0 deletions spp_mis_demo_v2/data/demo_api_client.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?xml version="1.0" encoding="utf-8" ?>
<!--
Demo API Client for QGIS Plugin Testing

This creates a pre-configured API client with GIS scopes for testing
the QGIS plugin integration. The client_secret is displayed in the UI
after installation - use it to configure the QGIS plugin.

Scopes granted:
- gis:read - View layers, catalog, and query statistics
- gis:all - Full GIS access including geofence management

IMPORTANT: This is demo data for testing only. In production,
create API clients through the UI with proper access controls.
-->
<odoo noupdate="1">
<!-- Demo API Client for QGIS Plugin -->
<record id="demo_api_client_qgis" model="spp.api.client">
<field name="name">QGIS Demo Client</field>
<field
name="description"
>Demo API client for testing QGIS plugin integration. Grants read access to GIS layers, reports, and statistics queries.</field>
<field name="partner_id" ref="base.main_partner" />
<field name="organization_type_id" ref="spp_consent.org_type_government" />
<field name="active" eval="True" />
</record>

<!-- GIS Read Scope - View layers, catalog, statistics -->
<record id="demo_api_client_qgis_scope_gis_read" model="spp.api.client.scope">
<field name="client_id" ref="demo_api_client_qgis" />
<field name="resource">gis</field>
<field name="action">read</field>
<field
name="description"
>Read access to GIS layers, reports catalog, and spatial statistics queries.</field>
</record>

<!-- GIS All Scope - Full GIS access including geofences -->
<record id="demo_api_client_qgis_scope_gis_all" model="spp.api.client.scope">
<field name="client_id" ref="demo_api_client_qgis" />
<field name="resource">gis</field>
<field name="action">all</field>
<field
name="description"
>Full GIS access including creating and managing geofences.</field>
</record>
</odoo>
267 changes: 267 additions & 0 deletions spp_mis_demo_v2/data/demo_statistics.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,267 @@
<?xml version="1.0" encoding="utf-8" ?>
<!--
Demo Statistics for GIS and Dashboard

This file creates:
1. CEL variables that define the computation logic
2. Statistics (spp.statistic) that publish those variables to GIS/dashboards

The separation allows the same underlying variable to be published
to multiple contexts with different presentation settings.
-->
<odoo noupdate="1">
<!-- ═══════════════════════════════════════════════════════════════════════
CEL VARIABLES - Define the computation logic
═══════════════════════════════════════════════════════════════════════ -->

<!-- Total Members - Aggregate count of all members -->
<record id="cel_var_total_members" model="spp.cel.variable">
<field name="name">demo_total_members</field>
<field name="cel_accessor">total_members</field>
<field name="source_type">aggregate</field>
<field name="aggregate_type">count</field>
<field name="aggregate_target">members</field>
<field name="aggregate_filter">true</field>
<field name="value_type">number</field>
<field name="applies_to">group</field>
<field name="category_id" ref="spp_studio.variable_category_demographics" />
<field name="state">active</field>
<field name="sequence">10</field>
</record>

<!-- Children Under 5: use spp_studio.var_children_under_5 (same cel_accessor + applies_to) -->

<!-- Children Under 18 -->
<record id="cel_var_children_under_18" model="spp.cel.variable">
<field name="name">demo_children_under_18</field>
<field name="cel_accessor">children_under_18</field>
<field name="source_type">aggregate</field>
<field name="aggregate_type">count</field>
<field name="aggregate_target">members</field>
<field name="aggregate_filter">age_years(m.birthdate) &lt; 18</field>
<field name="value_type">number</field>
<field name="applies_to">group</field>
<field name="category_id" ref="spp_studio.variable_category_demographics" />
<field name="state">active</field>
<field name="sequence">30</field>
</record>

<!-- Elderly 60+ -->
<record id="cel_var_elderly_60_plus" model="spp.cel.variable">
<field name="name">demo_elderly_60_plus</field>
<field name="cel_accessor">elderly_60_plus</field>
<field name="source_type">aggregate</field>
<field name="aggregate_type">count</field>
<field name="aggregate_target">members</field>
<field name="aggregate_filter">age_years(m.birthdate) >= 60</field>
<field name="value_type">number</field>
<field name="applies_to">group</field>
<field name="category_id" ref="spp_studio.variable_category_demographics" />
<field name="state">active</field>
<field name="sequence">40</field>
</record>

<!-- Disabled Members -->
<record id="cel_var_disabled_members" model="spp.cel.variable">
<field name="name">demo_disabled_members</field>
<field name="cel_accessor">disabled_members</field>
<field name="source_type">aggregate</field>
<field name="aggregate_type">count</field>
<field name="aggregate_target">members</field>
<field name="aggregate_filter">m.disabled != null</field>
<field name="value_type">number</field>
<field name="applies_to">group</field>
<field name="category_id" ref="spp_studio.variable_category_characteristics" />
<field name="state">active</field>
<field name="sequence">50</field>
</record>

<!-- Female Members -->
<record id="cel_var_female_members" model="spp.cel.variable">
<field name="name">demo_female_members</field>
<field name="cel_accessor">female_members</field>
<field name="source_type">aggregate</field>
<field name="aggregate_type">count</field>
<field name="aggregate_target">members</field>
<field name="aggregate_filter">is_female(m.gender_id)</field>
<field name="value_type">number</field>
<field name="applies_to">group</field>
<field name="category_id" ref="spp_studio.variable_category_demographics" />
<field name="state">active</field>
<field name="sequence">45</field>
</record>

<!-- Male Members -->
<record id="cel_var_male_members" model="spp.cel.variable">
<field name="name">demo_male_members</field>
<field name="cel_accessor">male_members</field>
<field name="source_type">aggregate</field>
<field name="aggregate_type">count</field>
<field name="aggregate_target">members</field>
<field name="aggregate_filter">is_male(m.gender_id)</field>
<field name="value_type">number</field>
<field name="applies_to">group</field>
<field name="category_id" ref="spp_studio.variable_category_demographics" />
<field name="state">active</field>
<field name="sequence">46</field>
</record>

<!-- Total Households (computed - returns true for counting) -->
<record id="cel_var_total_households" model="spp.cel.variable">
<field name="name">demo_total_households</field>
<field name="cel_accessor">total_households</field>
<field name="source_type">computed</field>
<field name="cel_expression">true</field>
<field name="value_type">number</field>
<field name="applies_to">group</field>
<field name="category_id" ref="spp_studio.variable_category_demographics" />
<field name="state">active</field>
<field name="sequence">5</field>
</record>

<!-- Program Enrollment (queries spp.program.membership via CEL enrollments symbol) -->
<record id="cel_var_enrolled_any_program" model="spp.cel.variable">
<field name="name">demo_enrolled_any_program</field>
<field name="cel_accessor">enrolled_any_program</field>
<field name="source_type">computed</field>
<field name="cel_expression">enrollments.exists(true)</field>
<field name="value_type">number</field>
<field name="applies_to">group</field>
<field name="category_id" ref="spp_studio.variable_category_program" />
<field name="state">active</field>
<field name="sequence">60</field>
</record>

<!-- ═══════════════════════════════════════════════════════════════════════
STATISTICS - Publish variables to GIS, dashboards, etc.
═══════════════════════════════════════════════════════════════════════ -->

<!-- Total Households -->
<record id="stat_total_households" model="spp.statistic">
<field name="name">total_households</field>
<field name="label">Total Households</field>
<field name="description">Count of household groups in the selected area</field>
<field name="variable_id" ref="cel_var_total_households" />
<field name="format">count</field>
<field name="unit">households</field>
<field name="category_id" ref="spp_statistic.category_demographics" />
<field name="sequence">10</field>
<field name="is_published_gis" eval="True" />
<field name="is_published_dashboard" eval="True" />
<field name="is_published_api" eval="True" />
</record>

<!-- Total Members -->
<record id="stat_total_members" model="spp.statistic">
<field name="name">total_members</field>
<field name="label">Total Members</field>
<field name="description">Total count of individual household members</field>
<field name="variable_id" ref="cel_var_total_members" />
<field name="format">count</field>
<field name="unit">people</field>
<field name="category_id" ref="spp_statistic.category_demographics" />
<field name="sequence">15</field>
<field name="is_published_gis" eval="True" />
<field name="is_published_dashboard" eval="True" />
</record>

<!-- Children Under 5 -->
<record id="stat_children_under_5" model="spp.statistic">
<field name="name">children_under_5</field>
<field name="label">Children Under 5</field>
<field name="description">Count of children under 5 years old</field>
<field name="variable_id" ref="spp_studio.var_children_under_5" />
<field name="format">count</field>
<field name="unit">children</field>
<field name="category_id" ref="spp_statistic.category_demographics" />
<field name="sequence">20</field>
<field name="is_published_gis" eval="True" />
<field name="is_published_dashboard" eval="True" />
</record>

<!-- Children Under 18 -->
<record id="stat_children_under_18" model="spp.statistic">
<field name="name">children_under_18</field>
<field name="label">Children Under 18</field>
<field name="description">Count of children under 18 years old</field>
<field name="variable_id" ref="cel_var_children_under_18" />
<field name="format">count</field>
<field name="unit">children</field>
<field name="category_id" ref="spp_statistic.category_demographics" />
<field name="sequence">30</field>
<field name="is_published_gis" eval="True" />
<field name="is_published_dashboard" eval="True" />
</record>

<!-- Elderly 60+ -->
<record id="stat_elderly_60_plus" model="spp.statistic">
<field name="name">elderly_60_plus</field>
<field name="label">Elderly (60+)</field>
<field name="description">Count of elderly persons aged 60 and above</field>
<field name="variable_id" ref="cel_var_elderly_60_plus" />
<field name="format">count</field>
<field name="unit">people</field>
<field name="category_id" ref="spp_statistic.category_demographics" />
<field name="sequence">40</field>
<field name="is_published_gis" eval="True" />
<field name="is_published_dashboard" eval="True" />
</record>

<!-- Female Members -->
<record id="stat_female_members" model="spp.statistic">
<field name="name">female_members</field>
<field name="label">Female Members</field>
<field name="description">Count of female household members</field>
<field name="variable_id" ref="cel_var_female_members" />
<field name="format">count</field>
<field name="unit">people</field>
<field name="category_id" ref="spp_statistic.category_demographics" />
<field name="sequence">45</field>
<field name="is_published_gis" eval="True" />
<field name="is_published_dashboard" eval="True" />
</record>

<!-- Male Members -->
<record id="stat_male_members" model="spp.statistic">
<field name="name">male_members</field>
<field name="label">Male Members</field>
<field name="description">Count of male household members</field>
<field name="variable_id" ref="cel_var_male_members" />
<field name="format">count</field>
<field name="unit">people</field>
<field name="category_id" ref="spp_statistic.category_demographics" />
<field name="sequence">46</field>
<field name="is_published_gis" eval="True" />
<field name="is_published_dashboard" eval="True" />
</record>

<!-- Disabled Members -->
<record id="stat_disabled_members" model="spp.statistic">
<field name="name">disabled_members</field>
<field name="label">Disabled Members</field>
<field name="description">Count of household members with disabilities</field>
<field name="variable_id" ref="cel_var_disabled_members" />
<field name="format">count</field>
<field name="unit">people</field>
<field name="category_id" ref="spp_statistic.category_vulnerability" />
<field name="sequence">50</field>
<field name="is_published_gis" eval="True" />
<field name="is_published_dashboard" eval="True" />
</record>

<!-- Program Enrollment -->
<record id="stat_enrolled_any_program" model="spp.statistic">
<field name="name">enrolled_any_program</field>
<field name="label">Enrolled (Any Program)</field>
<field
name="description"
>Count of households enrolled in at least one program</field>
<field name="variable_id" ref="cel_var_enrolled_any_program" />
<field name="format">count</field>
<field name="unit">households</field>
<field name="category_id" ref="spp_statistic.category_programs" />
<field name="sequence">60</field>
<field name="is_published_gis" eval="True" />
<field name="is_published_dashboard" eval="True" />
</record>
</odoo>
Loading
Loading