Introduction

This package implements a Markdown exporter for the PeakRDL toolchain.

Installing

Install from PyPi using pip:

python3 -m pip install peakrdl-markdown

Quick Start

Exporting to Python interface

The module integrates with PeakRDL CLI interface:

peakrdl markdown input_file.rdl -o output_file.md

Python compatibility

The library supports Python 3.8 and newer. For development, using Python 3.12 or later (the version shipped with current Ubuntu LTS) is recommended, as several developer-focused dependencies and tools require a newer Python and improve the development experience.

To install the library with Poetry for version smaller than 3.12 use:

poetry install --only main,test

For newer versions the --only main,test can be omitted.

Links

• Source repository

• Release Notes

• Issue tracker

• PyPi