Skip to content

Commit ae5a754

Browse files
committed
docs(spp_farmer_registry_demo,spp_mis_demo_v2): add generated READMEs
Include auto-generated README.rst and index.html from oca-gen-addon-readme (Python 3.11) to match CI expectations.
1 parent 70fc379 commit ae5a754

4 files changed

Lines changed: 793 additions & 55 deletions

File tree

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
.. image:: https://odoo-community.org/readme-banner-image
2+
:target: https://odoo-community.org/get-involved?utm_source=readme
3+
:alt: Odoo Community Association
4+
5+
============================
6+
OpenSPP Farmer Registry Demo
7+
============================
8+
9+
..
10+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
11+
!! This file is generated by oca-gen-addon-readme !!
12+
!! changes will be overwritten. !!
13+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
14+
!! source digest: sha256:dfca553e48db1d9dfc3054a44bbbd863e95bc030a1dc4d389285d1b660f043c1
15+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
16+
17+
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
18+
:target: https://odoo-community.org/page/development-status
19+
:alt: Production/Stable
20+
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
21+
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
22+
:alt: License: LGPL-3
23+
.. |badge3| image:: https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github
24+
:target: https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_farmer_registry_demo
25+
:alt: OpenSPP/OpenSPP2
26+
27+
|badge1| |badge2| |badge3|
28+
29+
Demo data generator for the OpenSPP Farmer Registry. Creates 8 named
30+
farmer personas with complete Philippine farm profiles, 5 agricultural
31+
subsidy programs with CEL eligibility expressions, and optionally
32+
generates ~730 volume farms from deterministic blueprints using a seeded
33+
random generator (``seed=42``) for reproducible output.
34+
35+
Key Capabilities
36+
~~~~~~~~~~~~~~~~
37+
38+
- **8 Fixed Story Farms** with hardcoded profiles (Maria Santos, Juan
39+
Dela Cruz, Rosa Garcia, Amir Mangudadatu, Sofia Martinez, Ramon dela
40+
Cruz, Sittie Pangandaman, Danilo Villanueva)
41+
- **~730 Volume Farms** generated deterministically from 21 blueprints
42+
via ``SeededFarmGenerator`` with ``random.Random(seed=42)`` — same
43+
seed always produces identical farms, members, and activities
44+
- **5 Demo Programs** with CEL-based eligibility and benefit formulas
45+
(Input Subsidy, Equipment Grant, Livestock Support, Climate
46+
Resilience, Aquaculture Support)
47+
- **2 Farm Cooperatives** demonstrating group-of-groups hierarchy (Nueva
48+
Ecija Rice Cooperative, BARMM Farmers Federation)
49+
- **3 Edge Case Personas** for testing eligibility boundaries (AgriCorp
50+
Holdings, Idle Land Farm, New Farmer)
51+
- Install Logic Packs from ``spp_studio`` for eligibility rules
52+
- Create program cycles with entitlements and payments
53+
- Create change requests at various workflow stages
54+
- Geographic distribution across 8 Philippine provinces with GPS
55+
coordinates and land parcel polygons
56+
57+
Key Models
58+
~~~~~~~~~~
59+
60+
+-------------------------------+-------------------------------------+
61+
| Model | Description |
62+
+===============================+=====================================+
63+
| ``spp.farmer.demo.generator`` | Core demo generator wizard with all |
64+
| | generation logic |
65+
+-------------------------------+-------------------------------------+
66+
67+
Configuration
68+
~~~~~~~~~~~~~
69+
70+
After installing:
71+
72+
1. Navigate to **Settings > Demo Data > Load Farmer Demo**
73+
2. Click "Load Demo Data" to generate
74+
75+
Demo Programs
76+
~~~~~~~~~~~~~
77+
78+
All programs use CEL expressions with activated registry variables:
79+
80+
- **Input Subsidy Program**: Per-hectare scaling for smallholders with
81+
productive land
82+
- **Equipment Grant Program**: Experience-based grant for farmers with
83+
2+ years
84+
- **Livestock Support Program**: Per-head scaling for livestock owners
85+
- **Climate Resilience Program**: Targets farms with idle land
86+
- **Aquaculture Support Program**: Activity-specific support for
87+
aquaculture farmers
88+
89+
Seeded Volume Generation
90+
~~~~~~~~~~~~~~~~~~~~~~~~
91+
92+
The ``SeededFarmGenerator`` uses ``random.Random(seed=42)`` for all
93+
structural choices:
94+
95+
- Farm names from Filipino last name pools
96+
- Member names (given + family) from locale-specific pools
97+
- Farm sizes, experience years, GPS coordinates
98+
- Activity quantities (crop areas, livestock counts, aquaculture)
99+
100+
Running the generator twice with the same seed produces identical
101+
output.
102+
103+
Security
104+
~~~~~~~~
105+
106+
================================ =========
107+
Group Access
108+
================================ =========
109+
``spp_security.group_spp_admin`` Full CRUD
110+
================================ =========
111+
112+
Dependencies
113+
~~~~~~~~~~~~
114+
115+
``spp_starter_farmer_registry``, ``spp_demo``,
116+
``spp_farmer_registry_cr``, ``spp_studio``,
117+
``spp_registry_group_hierarchy``, ``spp_area``, ``spp_programs``
118+
119+
**Table of contents**
120+
121+
.. contents::
122+
:local:
123+
124+
Bug Tracker
125+
===========
126+
127+
Bugs are tracked on `GitHub Issues <https://github.com/OpenSPP/OpenSPP2/issues>`_.
128+
In case of trouble, please check there if your issue has already been reported.
129+
If you spotted it first, help us to smash it by providing a detailed and welcomed
130+
`feedback <https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_farmer_registry_demo%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
131+
132+
Do not contact contributors directly about support or help with technical issues.
133+
134+
Credits
135+
=======
136+
137+
Authors
138+
-------
139+
140+
* OpenSPP.org
141+
142+
Maintainers
143+
-----------
144+
145+
.. |maintainer-jeremi| image:: https://github.com/jeremi.png?size=40px
146+
:target: https://github.com/jeremi
147+
:alt: jeremi
148+
.. |maintainer-gonzalesedwin1123| image:: https://github.com/gonzalesedwin1123.png?size=40px
149+
:target: https://github.com/gonzalesedwin1123
150+
:alt: gonzalesedwin1123
151+
.. |maintainer-emjay0921| image:: https://github.com/emjay0921.png?size=40px
152+
:target: https://github.com/emjay0921
153+
:alt: emjay0921
154+
155+
Current maintainers:
156+
157+
|maintainer-jeremi| |maintainer-gonzalesedwin1123| |maintainer-emjay0921|
158+
159+
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_farmer_registry_demo>`_ project on GitHub.
160+
161+
You are welcome to contribute.

0 commit comments

Comments
 (0)