Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
448 changes: 448 additions & 0 deletions spp_code_generator/COMPUTE_METHOD_ARCHITECTURE.md

Large diffs are not rendered by default.

596 changes: 596 additions & 0 deletions spp_code_generator/DERIVED_FIELDS_GUIDE.md

Large diffs are not rendered by default.

470 changes: 470 additions & 0 deletions spp_code_generator/IMPLEMENTATION_GUIDE.md

Large diffs are not rendered by default.

93 changes: 93 additions & 0 deletions spp_code_generator/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
=======================
OpenSPP Code Generator
=======================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:...
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
:target: https://odoo-community.org/page/development-status
:alt: Alpha
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OpenSPP%2Fopenspp--modules-lightgray.png?logo=github
:target: https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_code_generator
:alt: OpenSPP/openspp-modules

|badge1| |badge2| |badge3|

This module provides a YAML-based code generator for OpenSPP program registrants and groups.

**Table of contents**

.. contents::
:local:

Features
========

* Upload and validate YAML configuration files
* Automatic YAML syntax validation
* Unique filename constraint
* Integration with OpenSPP registry system

Configuration
=============

To configure this module:

#. Go to Code Generator > Code Generators
#. Click Create
#. Enter a filename (must end with .yaml or .yml)
#. Upload your YAML configuration file
#. The system will automatically validate the YAML syntax

Usage
=====

To use this module:

#. Navigate to Code Generator menu
#. Create a new code generator record
#. Upload your YAML file - the system will validate it automatically
#. The filename must be unique across all code generators

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OpenSPP/openspp-modules/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/OpenSPP/openspp-modules/issues/new?body=module:%20spp_code_generator%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Credits
=======

Authors
-------

* OpenSPP.org

Contributors
------------

* Jeremi Joslin <jeremi@openspp.org>
* Edwin Gonzales <gonzalesedwin1123@gmail.com>

Maintainers
-----------

This module is maintained by OpenSPP.org.

.. image:: https://openspp.org/logo.png
:alt: OpenSPP
:target: https://openspp.org

OpenSPP is a digital platform for social protection programs.

1 change: 1 addition & 0 deletions spp_code_generator/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
38 changes: 38 additions & 0 deletions spp_code_generator/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Part of OpenSPP. See LICENSE file for full copyright and licensing details.
{
"name": "OpenSPP Code Generator",
"category": "OpenSPP",
"version": "17.0.1.3.1",
"summary": "This module generates codes for program registrants and groups based on specifications written in a YAML file.",
"sequence": 1,
"author": "OpenSPP.org",
"website": "https://github.com/OpenSPP/openspp-modules",
"license": "LGPL-3",
"development_status": "Alpha",
"maintainers": ["jeremi", "gonzalesedwin1123"],
"depends": [
"base",
"mail",
"g2p_registry_base",
"g2p_registry_individual",
"g2p_registry_group",
"g2p_registry_membership",
"g2p_programs",
"spp_custom_field",
"spp_custom_fields_ui",
"spp_cel_domain",
],
"external_dependencies": {
"python": ["PyYAML"],
},
"data": [
"security/ir.model.access.csv",
"views/code_generator_views.xml",
],
"assets": {},
"demo": [],
"images": [],
"application": False,
"installable": True,
"auto_install": False,
}
2 changes: 2 additions & 0 deletions spp_code_generator/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from . import code_generator
from . import group
Loading
Loading