Merge pull request #32 from finos/cdm-deployment

Prepare for integration with CDM

Author: dschwartz-ftadvisory

.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

@@ -32,7 +32,7 @@ jobs:
       with:
         python-version: '3.11'
     - name: Build with Maven
-      run: mvn -B package --file pom.xml
+      run: mvn -B package -Psign-artifacts --file pom.xml
     - name: Run Python Unit Tests
       run: |
         chmod +x build/setup_python_env.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,39 @@
+# 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
+    # This section is crucial. It 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 your 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/[email protected]
+        with:
+          # The token is required to create pull requests.
+          # GITHUB_TOKEN is automatically created by Actions and is given
+          # the permissions defined in the `permissions` block above.
+          token: ${{ secrets.GITHUB_TOKEN }}
+          # Specifies the path to your Renovate configuration file.
+          configurationFile: .github/renovate.json
+        env:
+          # Use 'debug' for verbose logging, which is helpful for troubleshooting.
+          LOG_LEVEL: 'debug'
+          RENOVATE_REPOSITORIES: ${{ github.repository }} # This tells Renovate to scan the current repo
+

.gitignore

@@ -57,3 +57,5 @@ __pycache__
 **/test/serialization_tests/rune-common
 **/build/common-domain-model
 **/build/resources/serialization
+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 ([email protected]) and FT Advisory LLC ([email protected])
-
-This product includes software developed at the Fintech Open Source Foundation (https://www.finos.org/).
+# Rune Python Generator - FINOS
 
+Copyright 2023-2025 CLOUDRISK Limited (<[email protected]>) and FT Advisory LLC (<[email protected]>)
 
+This product includes software developed at the Fintech Open Source Foundation (<https://www.finos.org/>).

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.
-