Prepare for CDM Integration

.github/renovate.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["config:base"],
+  "prConcurrentLimit": 10,
+  "prHourlyLimit": 20,
+  "packageRules": [
+    {
+      "description": "Update the Maven property rosetta.dsl.version when com.regnosys.rosetta releases a new version",
+      "matchManagers": ["maven"],
+      "matchPackageNames": [
+        "com.regnosys.rosetta:com.regnosys.rosetta",
+        "rosetta.dsl.version"
+      ],
+      "enabled": true
+    },
+    {
+      "description": "Disable all that are not maven AND not those names",
+      "matchManagers": ["maven"],
+      "excludePackageNames": [
+        "com.regnosys.rosetta:com.regnosys.rosetta",
+        "rosetta.dsl.version"
+      ],
+      "enabled": false
+    }
+  ]
+}

.github/workflows/build-and-test-main.yml

@@ -1,12 +1,4 @@
-# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-
-name: Build and Test JAR
+name: Build and Test JAR on Main Branch
 
 on:
   push:
@@ -16,26 +8,4 @@ on:
 
 jobs:
   build_and_test:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up JDK 21
-      uses: actions/setup-java@v4
-      with:
-        java-version: '21'
-        distribution: 'temurin'
-        cache: maven
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.11'
-    - name: Build with Maven
-      run: mvn -B package --file pom.xml
-    - name: Run Python Unit Tests
-      run: |
-        chmod +x build/setup_python_env.sh
-        chmod +x test/python_unit_tests/setup_unit_test_env.sh
-        chmod +x test/python_unit_tests/run_python_unit_tests.sh
-        test/python_unit_tests/run_python_unit_tests.sh
+    uses: ./.github/workflows/build-and-test.yml

.github/workflows/build-and-test.yml

@@ -0,0 +1,29 @@
+name: Build and Test (Reusable)
+
+on:
+  workflow_call:
+
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'temurin'
+          cache: maven
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Build with Maven
+        run: mvn -B package -Psign-artifacts --file pom.xml
+      - name: Run Python Unit Tests
+        run: |
+          chmod +x test/python_setup/setup_python_env.sh
+          chmod +x test/python_setup/cleanup_python_env.sh
+          chmod +x test/python_unit_tests/setup_unit_test_env.sh
+          chmod +x test/python_unit_tests/run_python_unit_tests.sh
+          test/python_unit_tests/run_python_unit_tests.sh

.github/workflows/create-tagged-release.yml

@@ -1,4 +1,5 @@
-name: Build JAR on Tag
+name: Create Tagged Release
+# Build JAR and create tagged release
 
 on:
   push:
@@ -36,7 +37,7 @@ jobs:
         TAG_NAME=${GITHUB_REF#refs/tags/}
         echo "Updating POM version to $TAG_NAME"
         mvn -B versions:set -DnewVersion=$TAG_NAME
-        mvn -B package
+        mvn -B package -Psign-artifacts
 
     - name: Revert POM changes
       run: git checkout -- pom.xml

.github/workflows/renovate.yml

@@ -0,0 +1,36 @@
+# This workflow runs Renovate Bot on a schedule or on demand.
+# It uses the configuration file located at .github/renovate.json
+
+name: Renovate
+on:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+  # Runs the workflow on a schedule (e.g., every day at 2 AM)
+  schedule:
+    - cron: '0 2 * * *'
+
+jobs:
+  renovate:
+    runs-on: ubuntu-latest
+    # Grants the GITHUB_TOKEN the necessary permissions for Renovate to read repository content and create pull requests.
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      # Checks out the repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v4
+      # Runs the Renovate GitHub Action
+      - name: Renovate
+        # Using a slightly newer version of the action
+        uses: renovatebot/github-action@v40.2.2
+        with:
+          # The token is required to create pull requests.
+          token: ${{ secrets.GITHUB_TOKEN }}
+          # Specifies the path to your Renovate configuration file.
+          configurationFile: .github/renovate.json
+        env:
+          RENOVATE_REPOSITORIES: ${{ github.repository }} # This tells Renovate to scan the current repo
+  # Add a build and test job that depends on renovate
+  build_and_test:
+    needs: renovate
+    uses: ./.github/workflows/build-and-test.yml

.gitignore

@@ -55,5 +55,6 @@ __pycache__
 **/rune.runtime-*.*.*-py3-none-any.whl
 **/test_helper-0.0.0-py3-none-any.whl
 **/test/serialization_tests/rune-common
-**/build/common-domain-model
-**/build/resources/serialization
+**/test/cdm_tests/common-domain-model/
+src/generated/
+*.todo

CONTRIBUTING.md

@@ -8,7 +8,7 @@ Before making a contribution, please take the following steps:
 1. Check whether there's already an open issue related to your proposed contribution. If there is, join the discussion and propose your contribution there.
 2. If there isn't already a relevant issue, create one, describing your contribution and the problem you're trying to solve.
 3. Respond to any questions or suggestions raised in the issue by other developers.
-4. Fork the project repository and prepare your proposed contribution.
+4. Fork the project repository and prepare your proposed contribution.  The contribution must include unit tests to confirm that it behaves as expected.
 5. Submit a pull request.
 
 NOTE: All contributors must have a contributor license agreement (CLA) on file with FINOS before their pull requests will be merged. Please review the FINOS [contribution requirements](https://community.finos.org/docs/governance/Software-Projects/contribution-compliance-requirements) and submit (or have your employer submit) the required CLA before submitting a pull request.

NOTICE

@@ -1,6 +1,5 @@
-Rune Python Generator - FINOS
-Copyright 2023-2025 CLOUDRISK Limited (info@cloudrisk.uk) and FT Advisory LLC (info@ftadvisory.co)
-
-This product includes software developed at the Fintech Open Source Foundation (https://www.finos.org/).
+# Rune Python Generator - FINOS
 
+Copyright 2023-2025 CLOUDRISK Limited (<info@cloudrisk.uk>) and FT Advisory LLC (<info@ftadvisory.co>)
 
+This product includes software developed at the Fintech Open Source Foundation (<https://www.finos.org/>).

README.md

@@ -1,7 +1,6 @@
 [![FINOS - Incubating](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg)](https://community.finos.org/docs/governance/Software-Projects/stages/incubating)[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/10725/badge)](https://www.bestpractices.dev/projects/10725)[![Maven CI](https://github.com/finos/rune-python-generator/actions/workflows/cve-scanning.yml/badge.svg)](https://github.com/finos/rune-python-generator/actions/workflows/cve-scanning.yml)
 
-
-<img align="right" width="15%" src="https://www.finos.org/hubfs/FINOS/finos-logo/FINOS_Icon_Wordmark_Name_RGB_horizontal.png">
+<img align="right" width="15%" alt="FINOS" src="https://www.finos.org/hubfs/FINOS/finos-logo/FINOS_Icon_Wordmark_Name_RGB_horizontal.png">
 
 # Rune Python Generator
 
@@ -10,6 +9,7 @@
 The generated Python relies upon the [RunePythonRuntime](https://github.com/finos/rune-python-runtime) library and requires Python version 3.11+.
 
 ## Release Notes
+
 The features of the current version can be found in the [release notes](./RELEASE.md)
 
 ## Repository Organization
@@ -26,41 +26,59 @@ The features of the current version can be found in the [release notes](./RELEAS
 ## Development setup
 
 ### Setup for developers
+
 This guide is meant for everyone who wants to contribute to the Rune Python Generator and needs to get things up and running.
 
 Detailed build and testing instructions can be found in [BUILDANDTEST.md](./BUILDANDTEST.md)
 
 If this guide does not work for you, be sure to raise an issue. This way we can help you figure out what the problem is and update this guide to prevent the same problem for future users.
 
 ### 1. Building with Maven
+
 Start by cloning the project: `git clone https://github.com/finos/rune-python-generator`
 
 Our project runs with Java 21. Make sure that your Maven also uses this version of Java by running `mvn -v`.
 
-To build the project, run `mvn clean install`.
+To build the project, run `mvn clean package`.
 
 #### UNIT Testing
+
 Building the project using Maven will run JUNIT-based unit tests.  All tests should pass.  To run the Python unit tests follow the instructions in [BUILDANDTEST.md](./BUILDANDTEST.md)
 
 ### 2. Setting things up in Eclipse
+
 #### Install Eclipse IDE for Java and DSL Developers
+
 Install version `2025-06` of the "Eclipse IDE for Java and DSL Developers" using the [Eclipse Installer](https://www.eclipse.org/downloads/packages/installer). You might have to enable "Advanced Mode" in the settings of the Eclipse Installer to install a specific version.
 
 #### Configure Eclipse with the right version of Java
+
 Xtend files cannot be built with any Java version later than 21. In Eclipse, go to Settings... > Java > Installed JREs and make sure the checked JRE points to a Java version of 21.
 
 #### Install the Checkstyle plugin
+
 We use [Checkstyle](https://checkstyle.sourceforge.io/) for enforcing good coding practices. The Eclipse plugin for Checkstyle can be found here: [https://checkstyle.org/eclipse-cs/#!/](https://checkstyle.org/eclipse-cs/#!/).
 
 #### Open the project in Eclipse
+
 Go to Import... > Existing Maven Project, select the right folder, click Finish.
 
+### Standalone CLI
+
+The generator includes a standalone CLI which can be invoked to generate Python from a single file or from directory.  To invoke the CLI, first build the project and then:
+
+```sh
+java -cp target/python-0.0.0.main-SNAPSHOT.jar com.regnosys.rosetta.generator.python.PythonCodeGeneratorCLI
+```
+
 ### To Generate CDM from Rune
 
 Use this script to generated the Python version of CDM
+
 ```sh
-build/build_cdm.sh
+test/cdm_tests/cdm_setup/build_cdm.sh
 ```
+
 The script will use the CDM from the branch specified in the file (E.G. master) of the [FINOS Repo](https://github.com/finos/common-domain-model) and generate a wheel in the project directory `target/python-cdm`
 
 To use a different version of CDM, update CDM_VERSION in the script.
@@ -69,21 +87,33 @@ To use a different version of CDM, update CDM_VERSION in the script.
 
 The Roadmap will be aligned to the [Rune-DSL](https://github.com/finos/rune-dsl/) and [CDM](https://github.com/finos/common-domain-model/blob/master/ROADMAP.md) roadmaps.
 
+### Rune-DSL Updates
+
+Renovate will generate a PR when the version of the DSL has been updated at com.regnosys.rosetta:com.regnosys.rosetta.  The PR will clarify whether the change succsessfully builds and passes JUNIT and Python unit testing.
+
+Any maintainer can merge changes that successfully build and pass the tests.  To make the revised generator available to CDM, post merge a new  release tagged with the version # of the updated DSL will be required.
+
+Build or testing failures should be escalated to [@plamen-neykov](https://github.com/plamen-neykov) or [@dschwartznyc](https://github.com/dschwartznyc) for remediation.
+
 ## Contributing
+
 For any questions, bugs or feature requests please open an [issue](https://github.com/finos/rune-python-generator/issues)
 For anything else please send an email to {project mailing list}.
 
 To submit a contribution:
+
 1. Fork it (<https://github.com/finos/rune-python-generator/fork>)
 2. Create your feature branch (`git checkout -b feature/fooBar`)
 3. Read our [contribution guidelines](.github/CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
 4. Commit your changes (`git commit -am 'Add some fooBar'`)
 5. Push to the branch (`git push origin feature/fooBar`)
 6. Create a new Pull Request
 
-_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool (or EasyCLA). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
+*_NOTE:* Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR
+who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged
+and blocked by the FINOS Clabot tool (or EasyCLA). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
 
-Unsure if you are covered under an existing CCLA? Email help@finos.org*
+If you are unsure if you are covered under an existing CCLA send an email to <help@finos.org>
 
 ## Get in touch with the Rune Python Generator Team
 
@@ -93,7 +123,7 @@ Unsure if you are covered under an existing CCLA? Email help@finos.org*
 
 ## Governance
 
-This project implements https://community.finos.org/docs/governance/#open-source-software-projects
+This project implements <https://community.finos.org/docs/governance/#open-source-software-projects>
 
 ## License
 
@@ -105,8 +135,8 @@ SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)
 
 ## Contributors
 
-- [CLOUDRISK Limited](https://www.cloudrisk.uk), email: info@cloudrisk.com
-- [FT Advisory LLC](https://www.ftadvisory.co), email: info@ftadvisory.co
-- [TradeHeader SL](https://www.tradeheader.com), email: info@tradeheader.com
+- [CLOUDRISK Limited](https://www.cloudrisk.uk), email: <info@cloudrisk.com>
+- [FT Advisory LLC](https://www.ftadvisory.co), email: <info@ftadvisory.co>
+- [TradeHeader SL](https://www.tradeheader.com), email: <info@tradeheader.com>
 
 SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)

RELEASE.md

@@ -2,17 +2,27 @@
 
 _What is being released?_
 
-This release adds support for meta data and for serialization / deserialization consistent with the [serialization specifications in CDM issue #3236](https://github.com/finos/common-domain-model/issues/3236)
+This release adds support for metadata and for serialization / deserialization consistent with the [serialization specifications in CDM issue #3236](https://github.com/finos/common-domain-model/issues/3236)
 
-Also included is support for circular dependencies and increased testing of operators.
+Also included is support for:
 
-# Reading From and Writing To a String
+- circular Type definitions
+- increased testing of operators
+- generating Python across multiple namespaces
+- Command line (CLI) generation of Python from a Rune source file or directory.  To execute the CLI (assuming
+the default process wherein the JAR is built in the target directory): 
+
+```bash
+ java -cp target/python-0.0.0.main-SNAPSHOT.jar com.regnosys.rosetta.generator.python.PythonCodeGeneratorCLI -s [rune source files] -t [target directory for generated Python]
+```
+
+## Reading From and Writing To a String
 
 The generated Python code can deserialize and serialize an object.
 
-## Deserializing from a string
+### Deserializing from a string
 
-To deserialize from a string and create a object of the model specified in the string invoke the function:
+To deserialize from a string and create an object of the model specified in the string invoke the function:
 
 `BaseDataClass.rune_deserialize` with the following parameters
 
@@ -27,9 +37,11 @@ To deserialize from a string and create a object of the model specified in the s
     Returns:
       BaseModel: The Rune model.
 
-To serialize from an object ("[obj]") of a generated class, invoke the function:
+### Serialize to a string
+
+To serialize from a Rune object ("obj"), invoke the function:
 
-`[obj].rune_serialize` with the following parameters:
+`obj.rune_serialize` with the following parameters:
 
     validate_model (bool, optional): Validate that the model passes all Rune defined constraings prior to serialization. Setting to False allows serialization of an invalid Model. Defaults to True.
 
@@ -59,7 +71,5 @@ To serialize from an object ("[obj]") of a generated class, invoke the function:
 
     exclude_none (bool, optional): Determines whether to exclude fields that have a value of `None`. If True, fields set to None will be included.  Defaults to False.
 
-
     Returns:
       A string.
-