You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+56-20Lines changed: 56 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,9 @@
6
6
7
7
This repository creates a generator that will produce Python from a model developed using [Rune](https://github.com/finos/rune-dsl). The generated Python relies upon the [RunePythonRuntime]() library.
8
8
9
-
The generator supports creation of Python for the full Rune type syntax, and, as described in [EXPRESSION_SUPPORT.md](./EXPRESSION_SUPPORT.md), expression coverage is comprehensive. The generator does not yet fully implement function generation.
9
+
**Continuous Integration:**
10
+
11
+
*Rune Python Generator* - the generator supports creation of Python for the full Rune type syntax, and, as described in [EXPRESSION_SUPPORT.md](./EXPRESSION_SUPPORT.md), expression coverage is comprehensive. The generator does not yet fully implement function generation.
10
12
11
13
The Python package requires Python version 3.11+.
12
14
@@ -21,19 +23,50 @@ The Python package requires Python version 3.11+.
21
23
-`build/build_cdm.sh` - used to create a Python package from code generated using CDM Rune definitions
22
24
-`test` - Python unit tests and scripts to run the tests
23
25
24
-
## Installation Steps
26
+
## Development setup
27
+
28
+
### Setup for developers
29
+
This guide is meant for everyone who wants to contribute to the Rune Pyhton Generator and needs to get things up and running.
30
+
25
31
Detailed build and testing instructions can be found in [BUILDANDTEST.md](./BUILDANDTEST.md)
26
32
27
-
A quick overview follows:
33
+
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.
34
+
35
+
### 1. Building with Maven
36
+
Start by cloning the project: `git clone https://github.com/regnosys/rune-python-generator`
37
+
38
+
Our project runs with Java 21. Make sure that your Maven also uses this version of Java by running `mvn -v`.
39
+
40
+
To build the project, run `mvn clean install`.
28
41
29
-
1. Make a local copy of this repo
30
-
2. Build and test using Maven
31
-
```
32
-
cd rune-python-generator
33
-
mvn -s clean install
34
-
```
35
42
All the tests should pass.
36
43
44
+
### 2. Setting things up in Eclipse
45
+
#### Install Eclipse IDE for Java and DSL Developers
46
+
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.
47
+
48
+
#### Configure Eclipse with the right version of Java
49
+
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.
50
+
51
+
#### Install the Checkstyle plugin
52
+
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/#!/).
53
+
54
+
#### Open the project in Eclipse
55
+
Go to Import... > Existing Maven Project, select the right folder, click Finish.
56
+
57
+
### To Generate CDM from Rune
58
+
59
+
Use this script to generated the Python version of CDM
60
+
```sh
61
+
build/build_cdm.sh
62
+
```
63
+
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`
64
+
65
+
To use a different version of CDM, update CDM_VERSION in the script.
66
+
67
+
## Roadmap
68
+
69
+
The roadmap follows the roadmap for the [Rune-DSL](https://github.com/finos/rune-dsl/)
37
70
38
71
## Contributing
39
72
For any questions, bugs or feature requests please open an [issue](https://github.com/regnosys/rune-python-generator/issues)
@@ -47,20 +80,15 @@ To submit a contribution:
47
80
5. Push to the branch (`git push origin feature/fooBar`)
48
81
6. Create a new Pull Request
49
82
50
-
# To Generate CDM from Rune
83
+
_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.
51
84
52
-
Use this script to generated the Python version of CDM
53
-
```sh
54
-
build/build_cdm.sh
55
-
```
56
-
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`
85
+
Unsure if you are covered under an existing CCLA? Email [email protected]*
57
86
58
-
To use a different version of CDM, update CDM_VERSION in the script.
87
+
## Get in touch with the Rune Python Generator Team
Get in touch with the Rune team by creating a [GitHub issue](https://github.com/REGnosys/rune-python-dsl/issues/new) and labelling it with "help wanted".
90
+
91
+
We encourage the community to get in touch via the [FINOS Slack](https://www.finos.org/blog/finos-announces-new-community-slack).
64
92
65
93
## Governance
66
94
@@ -73,3 +101,11 @@ Copyright 2023-2025 CLOUDRISK Limited and FT Advisory LLC
73
101
Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
0 commit comments