Skip to content

Conversation

@engdoreis
Copy link
Collaborator

@engdoreis engdoreis commented Aug 4, 2025

This PR prepares the two packages hosted in this repository to be published in pypi.

  • rdlexporter: A library to generate SystemRDL files from the Hierarchical Register Model.
  • rdl2ot: A PeakRDL extension to generate Opentitan style source files from SystemRDL files.

This is how the published package will look like in Pypi:
https://test.pypi.org/project/rdlexporter/
https://test.pypi.org/project/rdl2ot/

@engdoreis engdoreis requested a review from machshev August 4, 2025 11:31
@engdoreis engdoreis force-pushed the develop branch 2 times, most recently from 33cad63 to 08e2242 Compare August 4, 2025 14:07
Signed-off-by: Douglas Reis <[email protected]>
@engdoreis engdoreis force-pushed the develop branch 2 times, most recently from b1d1d5e to 6a6314a Compare August 5, 2025 15:39
Copy link

@machshev machshev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This generally looks good! This will be a huge improvement, thanks.

Some nits, but up to you what you take from them.

executionEnvironments = [
{ root = "src" },
]

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no ruff tool config here. Which is fine if the defaults are okay, but it might be worth explicitly specifying in case the defaults change?

packages = ["src/rdlexporter"]
requires = ["uv_build>=0.8.4,<0.9.0"]
build-backend = "uv_build"

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment here about the ruff config.

[tool.setuptools]
py-modules = []

[tool.ruff]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noticed you have the ruff config here. If the LSPs pick this up okay then great! Might be worth checking they don't stop at the package level pyproject.toml when discovering the ruff config.

A quick test could be to set the line length to 10 or something and then run ruff inside one of the package directories?

Actually I guess the IDE may pick up the pyproject.toml from the root of the repo first? Not sure, but it might be worth opening neovim from the context of a subdir within a package and then again at the repo root and see if there is a difference in terms of rule discovery.

@engdoreis engdoreis merged commit 5f9acfc into main Aug 6, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants