Support for Serialization, Metadata and Fix for Circular Dependencies

.github/workflows/python-package-conda.yml

@@ -0,0 +1,38 @@
+name: Build and Release Wheel
+
+on:
+  push:
+    tags:
+      - '**'  # Trigger on tags like v1.0.0, v2.1.3, etc.
+
+jobs:
+  build-and-release:
+    name: Build Wheel and Create Release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Needed for setuptools_scm to determine version from git tags
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build setuptools setuptools_scm wheel pytest-runner
+
+      - name: Build wheel
+        run: |
+          python -m build --wheel
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*.whl
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -17,4 +17,13 @@ website/.docusaurus
 
 website/npm-debug.log*
 website/yarn-debug.log*
-website/yarn-error.log*
+website/yarn-error.log*
+
+# python related artefacts and directories
+__pycache__
+.pydevenv
+build
+src/rune.runtime.egg-info
+rune.runtime-*.whl
+src/rune/runtime/version.py
+/.coverage

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal"
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "."
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

NOTICE

@@ -1,5 +1,5 @@
-{project name} - FINOS
-Copyright {yyyy} - {current year} {name of copyright owner} {email of copyright holder}
+Rune Python Runtime - FINOS
+Copyright 2023 - 2025 {name of copyright owner} {email of copyright holder}
 
 This product includes software developed at the Fintech Open Source Foundation (https://www.finos.org/).
 

README.md

@@ -1,24 +1,78 @@
-<img align="right" width="40%" src="https://www.finos.org/hubfs/FINOS/finos-logo/FINOS_Icon_Wordmark_Name_RGB_horizontal.png">
+[![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)
 
-# FINOS Software Project Blueprint
+# Rune Python Runtime
 
-Project blueprint is a GitHub repository template for all [Fintech Open Source Foundation (FINOS)](https://www.finos.org/) hosted GitHub repositories, contributed and maintained by FINOS.
+The Rune Python Runtime supports and is an integral part of Python code generated from a [Rune DSL](https://github.com/finos/rune-dsl) defined model.  Rune DSL is a Domain-Specific Language used to model Financial Markets activities including the [Common Domain Model (CDM)](https://github.com/finos/common-domain-model).  
 
-## How to use this blueprint
+The Rune Python Runtime is used in collaboration with the [Rune Python Code Generator](https://github.com/REGnosys/rosetta-code-generators) to translate a Rune DSL model into a fully usable Python package.
 
-Please follow instructions on [community.finos.org/docs/collaboration-infrastructure#finos-project-blueprint](https://community.finos.org/docs/collaboration-infrastructure#finos-project-blueprint)
 
-## Blueprint preview
+## Installation
 
-A preview of the blueprint can be found on [project-blueprint.finos.org](https://project-blueprint.finos.org)
+The runtime is not generally installed on a stand alone basis but rather comes as part of a generated package such as CDM.
 
-## Governance
-This blueprint implements https://community.finos.org/docs/governance/#open-source-software-projects
+Regardless, to install the package standalone:
+
+1. Fetch the latest release data from the GitHub API
+```sh
+release_data=$(curl -s https://api.github.com/repos/REGnosys/rune-python-runtime/releases/latest)
+```
+2. Extract the download URL of the first asset
+```sh
+download_url=$(echo "$release_data" | grep '"browser_download_url":' | head -n 1 | sed -E 's/.*"([^"]+)".*/\1/')
+```
+3. Download the artifact using wget or curl
+```sh
+wget "$download_url"
+```
+
+4. Install the Runtime
+```sh
+python -m pip install rune.runtime*-py3-*.whl
+```
+
+## Development setup
+
+Use [dev_clean_setup.sh](https://github.com/Cloudrisk/rune-python-runtime/blob/main/dev_clean_setup.sh) to setup a development environment.
+
+```sh
+./dev_clean_setup.sh
+```
+Use [build_wheel.sh](https://github.com/Cloudrisk/rune-python-runtime/blob/main/build_wheel.sh) to build the package
+```sh
+./build_wheel.sh
+```
+To run the unit tests:
+```sh
+test/run_runtime_tests.sh
+```
+
+## Roadmap
+
+The Roadmap will be aligned to the Rune DSL and [CDM](https://github.com/finos/common-domain-model/blob/master/ROADMAP.md) roadmaps.
+
+In addition, the intention is to make future releases available at [PyPi](https://pypi.org)
+
+## Contributing
+For any questions, bugs or feature requests please open an [issue](https://github.com/finos/{project slug}/issues)
+For anything else please send an email to {project mailing list}.
+
+To submit a contribution:
+1. Fork it (<https://github.com/finos/{project slug}/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](https://community.finos.org/docs/governance/Software-Projects/easycla)). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
+
+*Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org)*
 
 ## License
 
-Copyright 2019 Fintech Open Source Foundation
+Copyright {yyyy} {name of copyright owner}
 
 Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
 
-SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)
+SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)

build_wheel.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+function error
+{
+    echo
+    echo "***************************************************************************"
+    echo "*                                                                         *"
+    echo "*                          WHEEL Build FAILED!                            *"
+    echo "*                                                                         *"
+    echo "***************************************************************************"
+    echo
+    exit -1
+}
+
+MY_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+cd ${MY_PATH} || error
+
+if [ -d ".pydevenv" ]; then
+    export PATH=`echo $PATH | tr ":" "\n" | grep -v ".pydevenv" | tr "\n" ":"`
+fi
+type -P python > /dev/null && PY_EXE=python || PY_EXE=python3
+
+${PY_EXE} -m pip wheel --no-deps --only-binary :all: . || error

dev_clean_setup.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+function error
+{
+    echo
+    echo "***************************************************************************"
+    echo "*                                                                         *"
+    echo "*                     DEV ENV Initialization FAILED!                      *"
+    echo "*                                                                         *"
+    echo "***************************************************************************"
+    echo
+    exit -1
+}
+
+MY_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+cd ${MY_PATH} || error
+
+
+if [ -d ".pydevenv" ]; then
+    export PATH=`echo $PATH | tr ":" "\n" | grep -v ".pydevenv" | tr "\n" ":"`
+fi
+
+
+type -P python > /dev/null && PY_EXE=python || PY_EXE=python3
+if [ -z "${WINDIR}" ]; then
+    PY_SCRIPTS='bin'
+else
+    PY_SCRIPTS='Scripts'
+fi
+
+
+${PY_EXE} -m venv --clear .pydevenv || error
+. .pydevenv/${PY_SCRIPTS}/activate || error
+
+
+pip install -r dev_requirements.txt || error
+python -m pip install -e . --config-settings editable_mode=compat || error

dev_requirements.txt

@@ -0,0 +1 @@
+pytest

pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=64", "setuptools_scm>=8", "wheel", "pytest-runner"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rune.runtime"
+dynamic = ["version"]
+requires-python = ">=3.11"
+dependencies = [
+   "pydantic>=2.10.3"
+]
+optional-dependencies.dev = [
+    "pytest",
+    "pytest-cov",
+    "pytest-mock"
+]
+description = "rune-runtime: the Rune DSL runtime for Python"
+readme = "README.md"
+keywords = [
+    "rune",
+    "rune runtime",
+]
+license = { text = "APACHE 2.0" }
+authors = [
+    { name = "Daniel Schwartz" },
+    { name = "Plamen Neykov" },
+    { name = "Others (See AUTHORS)" }
+]
+classifiers = [
+    "Development Status :: 6 - Mature",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache 2.0 License",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX",
+    "Operating System :: Unix",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Rune DSL",
+    "Topic :: Software Development :: Rune DSL Runtime"
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools_scm]
+version_file = "src/rune/runtime/version.py"

src/rune/runtime/__init__.py

@@ -0,0 +1,5 @@
+'''rune dsl runtime package'''
+# PEP 396 module version attribute in PEP 440 version format
+from .version import __version__
+
+# EOF