Rune Python Generator - the generator enables creation of Python from Rune. It supports the full Rune type syntax, and, as described in EXPRESSION_SUPPORT.md, expression coverage is comprehensive. The generator does not yet fully implement function generation.
The generated Python relies upon the RunePythonRuntime library and requires Python version 3.11+.
The features of the current version can be found in the release notes
README.md- this file, for documentation purposesBUILDANDTEST.md- instructions on building and testing the repoRELEASE.md- information about the current releasesrc/main- Java/Xtend code to generate Python from Runesrc/test- Java/Xtend code to run JUnit tests on the code generation processbuild- configuration scripts to setup and tear down the Python unit testing environmentbuild/build_cdm.sh- used to create a Python package from code generated using CDM Rune definitionstest- Python unit tests and scripts to run the tests
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
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.
Start by cloning the project: git clone https://github.com/regnosys/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.
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
Install version 2025-06 of the "Eclipse IDE for Java and DSL Developers" using the Eclipse Installer. You might have to enable "Advanced Mode" in the settings of the Eclipse Installer to install a specific version.
Xtend files cannot be build 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.
We use Checkstyle for enforcing good coding practices. The Eclipse plugin for Checkstyle can be found here: https://checkstyle.org/eclipse-cs/#!/.
Go to Import... > Existing Maven Project, select the right folder, click Finish.
Use this script to generated the Python version of CDM
build/build_cdm.shThe script will use the CDM from the branch specified in the file (E.G. master) of the FINOS Repo and generate a wheel in the project directory target/python-cdm
To use a different version of CDM, update CDM_VERSION in the script.
The Roadmap will be aligned to the Rune-DSL and CDM roadmaps.
- CLOUDRISK Limited, email: info@cloudrisk.com
- FT Advisory LLC, email: info@ftadvisory.co
- TradeHeader SL, email: info@tradeheader.com
For any questions, bugs or feature requests please open an issue For anything else please send an email to {project mailing list}.
To submit a contribution:
- Fork it (https://github.com/regnosys/rune-python-generator/fork)
- Create your feature branch (
git checkout -b feature/fooBar) - Read our contribution guidelines and Community Code of Conduct
- Commit your changes (
git commit -am 'Add some fooBar') - Push to the branch (
git push origin feature/fooBar) - 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.
Unsure if you are covered under an existing CCLA? Email help@finos.org*
Get in touch with the Rune team by creating a GitHub issue and labelling it with "help wanted".
We encourage the community to get in touch via the FINOS Slack.
This project implements https://community.finos.org/docs/governance/#open-source-software-projects
Copyright 2023-2025 CLOUDRISK Limited and FT Advisory LLC
Distributed under the Apache License, Version 2.0.
SPDX-License-Identifier: Apache-2.0
- CLOUDRISK Limited, email: info@cloudrisk.com
- FT Advisory LLC, email: info@ftadvisory.co
- TradeHeader SL, email: info@tradeheader.com
SPDX-License-Identifier: Apache-2.0