Skip to content

Commit c4181d4

Browse files
Merge branch 'develop' of https://github.com/finos/rune-python-generator into develop
2 parents 0d55a67 + 707a82a commit c4181d4

File tree

5 files changed

+43
-27
lines changed

5 files changed

+43
-27
lines changed
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build and Test JAR
1+
name: Build and Test JAR on Main Branch
22

33
on:
44
push:
@@ -8,4 +8,4 @@ on:
88

99
jobs:
1010
build_and_test:
11-
uses: ./.github/workflows/build-and-test.yml
11+
uses: ./.github/workflows/build-and-test.yml

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ __pycache__
5555
**/rune.runtime-*.*.*-py3-none-any.whl
5656
**/test_helper-0.0.0-py3-none-any.whl
5757
**/test/serialization_tests/rune-common
58-
**/build/common-domain-model
59-
**/build/resources/serialization
58+
**/test/cdm_tests/common-domain-model/
6059
src/generated/
6160
*.todo

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
[![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)[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/10725/badge)](https://www.bestpractices.dev/projects/10725)[![Maven CI](https://github.com/finos/rune-python-generator/actions/workflows/cve-scanning.yml/badge.svg)](https://github.com/finos/rune-python-generator/actions/workflows/cve-scanning.yml)
22

3-
4-
<img align="right" width="15%" src="https://www.finos.org/hubfs/FINOS/finos-logo/FINOS_Icon_Wordmark_Name_RGB_horizontal.png">
3+
<img align="right" width="15%" alt="FINOS" src="https://www.finos.org/hubfs/FINOS/finos-logo/FINOS_Icon_Wordmark_Name_RGB_horizontal.png">
54

65
# Rune Python Generator
76

@@ -10,6 +9,7 @@
109
The generated Python relies upon the [RunePythonRuntime](https://github.com/finos/rune-python-runtime) library and requires Python version 3.11+.
1110

1211
## Release Notes
12+
1313
The features of the current version can be found in the [release notes](./RELEASE.md)
1414

1515
## Repository Organization
@@ -26,33 +26,42 @@ The features of the current version can be found in the [release notes](./RELEAS
2626
## Development setup
2727

2828
### Setup for developers
29+
2930
This guide is meant for everyone who wants to contribute to the Rune Python Generator and needs to get things up and running.
3031

3132
Detailed build and testing instructions can be found in [BUILDANDTEST.md](./BUILDANDTEST.md)
3233

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

3536
### 1. Building with Maven
37+
3638
Start by cloning the project: `git clone https://github.com/finos/rune-python-generator`
3739

3840
Our project runs with Java 21. Make sure that your Maven also uses this version of Java by running `mvn -v`.
3941

42+
To build the project, run `mvn clean package`.
4043
To build the project, run `mvn clean package`.
4144

4245
#### UNIT Testing
46+
4347
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)
4448

4549
### 2. Setting things up in Eclipse
50+
4651
#### Install Eclipse IDE for Java and DSL Developers
52+
4753
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.
4854

4955
#### Configure Eclipse with the right version of Java
56+
5057
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.
5158

5259
#### Install the Checkstyle plugin
60+
5361
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/#!/).
5462

5563
#### Open the project in Eclipse
64+
5665
Go to Import... > Existing Maven Project, select the right folder, click Finish.
5766

5867
### Standalone CLI
@@ -65,9 +74,12 @@ java -cp target/python-0.0.0.main-SNAPSHOT.jar com.regnosys.rosetta.generator.py
6574
### To Generate CDM from Rune
6675

6776
Use this script to generated the Python version of CDM
77+
6878
```sh
6979
test/cdm_tests/cdm_setup/build_cdm.sh
80+
test/cdm_tests/cdm_setup/build_cdm.sh
7081
```
82+
7183
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`
7284

7385
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.
8597
Build or testing failures should be escalated to [@plamen-neykov](https://github.com/plamen-neykov) or [@dschwartznyc](https://github.com/dschwartznyc) for remediation.
8698

8799
## Contributing
100+
88101
For any questions, bugs or feature requests please open an [issue](https://github.com/finos/rune-python-generator/issues)
89102
For anything else please send an email to {project mailing list}.
90103

91104
To submit a contribution:
105+
92106
1. Fork it (<https://github.com/finos/rune-python-generator/fork>)
93107
2. Create your feature branch (`git checkout -b feature/fooBar`)
94108
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
110124

111125
## Governance
112126

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

115129
## License
116130

@@ -122,8 +136,8 @@ SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)
122136

123137
## Contributors
124138

125-
- [CLOUDRISK Limited](https://www.cloudrisk.uk), email: [email protected]
126-
- [FT Advisory LLC](https://www.ftadvisory.co), email: [email protected]
127-
- [TradeHeader SL](https://www.tradeheader.com), email: [email protected]
139+
- [CLOUDRISK Limited](https://www.cloudrisk.uk), email: <[email protected]>
140+
- [FT Advisory LLC](https://www.ftadvisory.co), email: <[email protected]>
141+
- [TradeHeader SL](https://www.tradeheader.com), email: <[email protected]>
128142

129143
SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)

pom.xml

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@
8181
<repoServerHost>s01.oss.sonatype.org</repoServerHost>
8282
<stagingTimeoutInMinutes>20</stagingTimeoutInMinutes>
8383

84-
<rosetta.dsl.version>9.63.0</rosetta.dsl.version>
84+
<rosetta.dsl.version>9.64.0</rosetta.dsl.version>
8585

8686
<xtext.version>2.38.0</xtext.version>
8787
<guice.version>6.0.0</guice.version>
@@ -455,6 +455,9 @@
455455
<groupId>org.apache.maven.plugins</groupId>
456456
<artifactId>maven-shade-plugin</artifactId>
457457
<version>3.5.0</version>
458+
<configuration>
459+
<createDependencyReducedPom>true</createDependencyReducedPom>
460+
</configuration>
458461
<executions>
459462
<execution>
460463
<phase>package</phase>
@@ -463,6 +466,7 @@
463466
</goals>
464467
<configuration>
465468
<transformers>
469+
<transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer" />
466470
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
467471
<mainClass>com.regnosys.rosetta.generator.python.PythonCodeGenCLI</mainClass>
468472
</transformer>
@@ -498,21 +502,21 @@
498502
</executions>
499503
</plugin>
500504
<plugin>
501-
<groupId>org.apache.maven.plugins</groupId>
502-
<artifactId>maven-javadoc-plugin</artifactId>
503-
<version>${maven-javadoc-plugin.version}</version>
504-
<configuration>
505-
<failOnError>false</failOnError>
506-
</configuration>
507-
<executions>
508-
<execution>
509-
<id>attach-javadocs</id>
510-
<phase>package</phase>
511-
<goals>
512-
<goal>jar</goal>
513-
</goals>
514-
</execution>
515-
</executions>
505+
<groupId>org.apache.maven.plugins</groupId>
506+
<artifactId>maven-javadoc-plugin</artifactId>
507+
<version>${maven-javadoc-plugin.version}</version>
508+
<configuration>
509+
<failOnError>false</failOnError>
510+
</configuration>
511+
<executions>
512+
<execution>
513+
<id>attach-javadocs</id>
514+
<phase>package</phase>
515+
<goals>
516+
<goal>jar</goal>
517+
</goals>
518+
</execution>
519+
</executions>
516520
</plugin>
517521
</plugins>
518522
</build>

test/cdm_tests/common-domain-model

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)