Skip to content

Commit 0cc0278

Browse files
emjay0921kneckinator
emjay0921
authored and
kneckinator
committed
[ADD] spp_base_spmis_demo
1 parent cf9a829 commit 0cc0278

9 files changed

Lines changed: 206 additions & 1 deletion

File tree

‎spp_base_farmer_registry_demo/__manifest__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"license": "LGPL-3",
1313
"development_status": "Production/Stable",
1414
"external_dependencies": {"python": ["faker"]},
15-
"maintainers": ["jeremi", "gonzalesedwin1123", "reichie020212"],
15+
"maintainers": ["jeremi", "gonzalesedwin1123", "emjay0921"],
1616
"depends": [
1717
"base",
1818
"g2p_registry_base",

‎spp_base_spmis_demo/README.rst‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
============================
2+
OpenSPP SPMIS Demo
3+
============================
4+
5+
..
6+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7+
!! This file is generated by oca-gen-addon-readme !!
8+
!! changes will be overwritten. !!
9+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10+
!! source digest: sha256:eccedea606c9a761d0cbd0031d2cb447564601925a78c0afd042d1bc7037897e
11+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
12+
13+
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
14+
:target: https://odoo-community.org/page/development-status
15+
:alt: Beta
16+
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
17+
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
18+
:alt: License: LGPL-3
19+
.. |badge3| image:: https://img.shields.io/badge/github-OpenSPP%2Fopenspp--modules-lightgray.png?logo=github
20+
:target: https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_base_spmis_demo
21+
:alt: OpenSPP/openspp-modules
22+
23+
|badge1| |badge2| |badge3|
24+
25+
OpenSPP SPMIS Demo
26+
============================
27+
28+
Overview
29+
--------
30+
31+
The `spp_base_spmis_demo <spp_base_spmis_demo>`__ module is a
32+
demonstration module for OpenSPP that provides pre-populated data for
33+
the SPMIS base registry. It builds upon the
34+
`spp_base_spmis <spp_base_spmis>`__ module and its
35+
dependencies to showcase the functionalities of the SPMIS registry with
36+
realistic sample data.
37+
38+
Purpose
39+
-------
40+
41+
This module aims to:
42+
43+
- Populate the SPMIS registry with sample data, including registrants,
44+
groups, and social protection information.
45+
- Provide a starting point for users to explore the SPMIS registry and
46+
its various features.
47+
- Demonstrate how different modules, such as
48+
`g2p_registry_membership <g2p_registry_membership>`__,
49+
`queue_job <queue_job>`__, and `spp_base_demo <spp_base_demo>`__,
50+
integrate to create a comprehensive SPMIS system.
51+
52+
Module Dependencies and Integration
53+
-----------------------------------
54+
55+
- `spp_base_spmis <spp_base_spmis>`__\ **:** This
56+
module depends heavily on
57+
`spp_base_spmis <spp_base_spmis>`__, inheriting
58+
its models and views to extend them with demo data generation
59+
capabilities.
60+
- `g2p_registry_membership <g2p_registry_membership>`__\ **:**
61+
Leverages `g2p_registry_membership <g2p_registry_membership>`__ for
62+
creating group memberships between individual registrants and groups.
63+
- `queue_job <queue_job>`__\ **:** Uses `queue_job <queue_job>`__ to
64+
handle the generation of large datasets in the background, improving
65+
performance and user experience.
66+
- `g2p_registry_base <g2p_registry_base>`__\ **:** Depends on
67+
`g2p_registry_base <g2p_registry_base>`__ for the basic registrant
68+
models and functionalities.
69+
- `g2p_registry_group <g2p_registry_group>`__\ **:** Uses
70+
`g2p_registry_group <g2p_registry_group>`__ for creating and managing
71+
groups as registrants.
72+
- `spp_base_demo <spp_base_demo>`__\ **:** Inherits from
73+
`spp_base_demo <spp_base_demo>`__ to include basic demo data, such as
74+
genders.
75+
- `g2p_registry_individual <g2p_registry_individual>`__\ **:** Utilizes
76+
`g2p_registry_individual <g2p_registry_individual>`__ for creating
77+
individual registrants.
78+
79+
Additional Functionality
80+
------------------------
81+
82+
The `spp_base_spmis_demo <spp_base_spmis_demo>`__ module
83+
introduces the following key functionalities:
84+
85+
- **Sample Data Generation:** The module includes capabilities for
86+
generating sample SPMIS data. This allows users to specify:
87+
88+
- The number of groups to generate.
89+
- The locale for generating realistic data based on specific
90+
regions.
91+
- Once the data generation is triggered, the module creates a queue
92+
job that populates the database with realistic SPMIS data,
93+
including:
94+
95+
- Groups: Groups of registrants with detailed information like
96+
family name, national ID, contact details, and education level.
97+
- Individual Registrants: Members of groups with personal
98+
information and links to their respective groups.
99+
- Social Protection Data: Comprehensive information about
100+
registrants' social protection status and program participation.
101+
102+
- **Data Realism:** The module utilizes external libraries like
103+
``faker`` to generate realistic and region-specific data for names,
104+
contact details, and other attributes. This ensures that the sample
105+
data reflects real-world scenarios.
106+
107+
Conclusion
108+
----------
109+
110+
The `spp_base_spmis_demo <spp_base_spmis_demo>`__ module
111+
provides a valuable tool for understanding and demonstrating the
112+
functionalities of the OpenSPP SPMIS system. By populating the
113+
database with realistic sample data, it allows users to explore the
114+
system, understand its data structures, and test its various features
115+
without having to manually create large datasets. This module simplifies
116+
the process of getting started with OpenSPP and showcases the platform's
117+
capabilities for managing comprehensive and detailed SPMIS registries.
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/openspp-modules/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/openspp-modules/issues/new?body=module:%20spp_base_spmis_demo%0Aversion:%2017.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-reichie020212| image:: https://github.com/reichie020212.png?size=40px
152+
:target: https://github.com/reichie020212
153+
:alt: reichie020212
154+
155+
Current maintainers:
156+
157+
|maintainer-jeremi| |maintainer-gonzalesedwin1123| |maintainer-reichie020212|
158+
159+
This module is part of the `OpenSPP/openspp-modules <https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_base_spmis_demo>`_ project on GitHub.
160+
161+
You are welcome to contribute.
162+

‎spp_base_spmis_demo/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Part of OpenSPP. See LICENSE file for full copyright and licensing details.

‎spp_base_spmis_demo/__manifest__.py‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Part of OpenSPP. See LICENSE file for full copyright and licensing details.
2+
3+
4+
{
5+
"name": "OpenSPP SPMIS Demo",
6+
"summary": "Generates and populates the OpenSPP SPMIS Base with comprehensive, realistic sample data. It integrates with core registry models to provide diverse registrant profiles and social protection data, facilitating system exploration, training, and testing.",
7+
"category": "OpenSPP",
8+
"version": "17.0.1.3.1",
9+
"sequence": 1,
10+
"author": "OpenSPP.org",
11+
"website": "https://github.com/OpenSPP/openspp-modules",
12+
"license": "LGPL-3",
13+
"development_status": "Production/Stable",
14+
"external_dependencies": {"python": ["faker"]},
15+
"maintainers": ["jeremi", "gonzalesedwin1123", "emjay0921"],
16+
"depends": [
17+
"base",
18+
"g2p_registry_base",
19+
"spp_base_spmis",
20+
"spp_demo_common",
21+
"queue_job",
22+
],
23+
"excludes": [
24+
"spp_base_farmer_registry",
25+
"spp_base_social_registry",
26+
],
27+
"data": [
28+
"security/ir.model.access.csv",
29+
],
30+
"assets": {},
31+
"demo": [],
32+
"images": [],
33+
"application": True,
34+
"installable": True,
35+
"auto_install": False,
36+
}

‎spp_base_spmis_demo/models/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Part of OpenSPP. See LICENSE file for full copyright and licensing details.

‎spp_base_spmis_demo/pyproject.toml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[build-system]
2+
requires = ["whool"]
3+
build-backend = "whool.buildapi"

‎spp_base_spmis_demo/security/ir.model.access.csv‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink

‎spp_base_spmis_demo/static/description/icon.png‎

15.1 KB
Loading

‎spp_base_spmis_demo/tests/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Part of OpenSPP. See LICENSE file for full copyright and licensing details.

0 commit comments

Comments
 (0)