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
The generated Python relies upon the [RunePythonRuntime](https://github.com/finos/rune-python-runtime) library and requires Python version 3.11+.
11
10
12
11
## Release Notes
12
+
13
13
The features of the current version can be found in the [release notes](./RELEASE.md)
14
14
15
15
## Repository Organization
@@ -26,33 +26,42 @@ The features of the current version can be found in the [release notes](./RELEAS
26
26
## Development setup
27
27
28
28
### Setup for developers
29
+
29
30
This guide is meant for everyone who wants to contribute to the Rune Python Generator and needs to get things up and running.
30
31
31
32
Detailed build and testing instructions can be found in [BUILDANDTEST.md](./BUILDANDTEST.md)
32
33
33
34
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
35
36
### 1. Building with Maven
37
+
36
38
Start by cloning the project: `git clone https://github.com/finos/rune-python-generator`
37
39
38
40
Our project runs with Java 21. Make sure that your Maven also uses this version of Java by running `mvn -v`.
39
41
42
+
To build the project, run `mvn clean package`.
40
43
To build the project, run `mvn clean package`.
41
44
42
45
#### UNIT Testing
46
+
43
47
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)
44
48
45
49
### 2. Setting things up in Eclipse
50
+
46
51
#### Install Eclipse IDE for Java and DSL Developers
52
+
47
53
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.
48
54
49
55
#### Configure Eclipse with the right version of Java
56
+
50
57
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.
51
58
52
59
#### Install the Checkstyle plugin
60
+
53
61
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/#!/).
54
62
55
63
#### Open the project in Eclipse
64
+
56
65
Go to Import... > Existing Maven Project, select the right folder, click Finish.
Use this script to generated the Python version of CDM
77
+
68
78
```sh
69
79
test/cdm_tests/cdm_setup/build_cdm.sh
80
+
test/cdm_tests/cdm_setup/build_cdm.sh
70
81
```
82
+
71
83
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`
72
84
73
85
To use a different version of CDM, update CDM_VERSION in the script.
@@ -85,10 +97,12 @@ Any maintainer can merge changes that successfully build and pass the tests.
85
97
Build or testing failures should be escalated to [@plamen-neykov](https://github.com/plamen-neykov) or [@dschwartznyc](https://github.com/dschwartznyc) for remediation.
86
98
87
99
## Contributing
100
+
88
101
For any questions, bugs or feature requests please open an [issue](https://github.com/finos/rune-python-generator/issues)
89
102
For anything else please send an email to {project mailing list}.
90
103
91
104
To submit a contribution:
105
+
92
106
1. Fork it (<https://github.com/finos/rune-python-generator/fork>)
93
107
2. Create your feature branch (`git checkout -b feature/fooBar`)
94
108
3. Read our [contribution guidelines](.github/CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
@@ -110,7 +124,7 @@ If you are unsure if you are covered under an existing CCLA send an email to hel
110
124
111
125
## Governance
112
126
113
-
This project implements https://community.finos.org/docs/governance/#open-source-software-projects
127
+
This project implements <https://community.finos.org/docs/governance/#open-source-software-projects>
0 commit comments