Skip to main content

Generate Header files from a SystemRDL register model

Project description

PeakRDL Raw Header

Generates a very basic header with addresses, sizes, and offsets from a SystemRDL file as a plugin to PeakRDL.

Currently supported formats:

Format Function
c Simple C header file
svh Simple SystemVerilog header file
svpkg Simple SystemVerilog package

Custom templates are also supported.

Installation

You can install the package via pip:

pip install peakrdl-rawheader

Or add it as a dependency in your pyproject.toml or requirements.txt e.g. with uv:

uv add peakrdl-rawheader

Publishing to PyPI

To create a new release on PyPI, follow the following steps:

  1. Bump the version number in pyproject.toml. If you are using uv, you can do this with:
uv version --bump major|minor|patch

You can also do this manually by editing pyproject.toml, but make sure you run uv lock afterwards to update the lock file as well.

  1. Edit the the CHANGELOG.md to reflect the changes in this new version.

  2. Commit the changes:

git add pyproject.toml uv.lock CHANGELOG.md
git commit -m "Release vX.Y.Z"
git push origin main
  1. Optional: You can try out publishing the package to TestPypi first by running the publish-test-pypi CI job that has a manual workflow_dispatch trigger.

  2. Create a new release on Github with the same version tag (e.g. vX.Y.Z).

This will automatially trigger a Github workflow to build and publish the package to PyPI using Trusted Publishing.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

peakrdl_rawheader-0.2.1.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

peakrdl_rawheader-0.2.1-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file peakrdl_rawheader-0.2.1.tar.gz.

File metadata

  • Download URL: peakrdl_rawheader-0.2.1.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for peakrdl_rawheader-0.2.1.tar.gz
Algorithm Hash digest
SHA256 997ca4ea52b7353d329f563484543e41e494f2353f6b7cda3b734a33849b7f92
MD5 6e7aa6336685f292040f595b1dbfc531
BLAKE2b-256 96dd6371f1571e03bf685e35332705259b066276b01cf808382efaa62c2e8c24

See more details on using hashes here.

File details

Details for the file peakrdl_rawheader-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: peakrdl_rawheader-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for peakrdl_rawheader-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e07895a4a83aa0a779c1da544a8d4fe49ee621bd509dcb58a74fa941b38745fb
MD5 271eff025995b78c621cbfea56b82329
BLAKE2b-256 8f64c4e458363ab03f09d7225ef1c57933a91918834754ef3c9ffa185eefb827

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page