Metadata-Version: 2.1
Name: peakrdl_python_simple
Version: 0.2.14
Summary: Export Python description from the systemrdl-compiler register model
Home-page: https://github.com/MarekPikula/PeakRDL-Python-simple
License: GPL-3.0-only
Author: Marek Pikuła
Author-email: marek.pikula@embevity.com
Maintainer: Marek Pikuła
Maintainer-email: marek.pikula@embevity.com
Requires-Python: >=3.7.2,<4.0.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Provides-Extra: cli
Provides-Extra: generator
Provides-Extra: tracing
Requires-Dist: loguru (>=0.6.0,<0.7.0) ; extra == "tracing"
Requires-Dist: peakrdl (>=0.9.0,<0.10.0) ; extra == "cli"
Requires-Dist: systemrdl-compiler (>=1.25.0,<2.0.0) ; extra == "generator" or extra == "cli"
Project-URL: Documentation, https://peakrdl-python-simple.readthedocs.io
Project-URL: Repository, https://github.com/MarekPikula/PeakRDL-Python-simple
Description-Content-Type: text/markdown

[![Documentation Status](https://readthedocs.org/projects/peakrdl-python-simple/badge/?version=latest)](http://peakrdl-python-simple.readthedocs.io)
[![build](https://github.com/MarekPikula/PeakRDL-Python-simple/workflows/build/badge.svg)](https://github.com/MarekPikula/PeakRDL-Python-simple/actions?query=workflow%3Abuild+branch%3Amain)
[![Coverage Status](https://coveralls.io/repos/github/MarekPikula/PeakRDL-Python-simple/badge.svg?branch=main)](https://coveralls.io/github/MarekPikula/PeakRDL-Python-simple?branch=main)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/peakrdl-python-simple.svg)](https://pypi.org/project/peakrdl-python-simple)

# PeakRDL-Python

This package implements Python register abstraction layer export for the
PeakRDL toolchain.

- **Export:** Convert compiled SystemRDL input into Python register interface.

For the command line tool, see the [PeakRDL
project](https://peakrdl.readthedocs.io).

## Usage

The basic install comes without the exporter capability, so that the package
can be installed on low-end devices without the need to install
`systemrdl-compiler`. To have the generator capability install with `generator`
extra:

    $ pip install peakrdl-python-simple[generator]

PeakRDL project provides a standard CLI interface. It can be installed directly
via pip or by installing this package with `cli` extra:

    $ pip install peakrdl-python-simple[cli]

Then this package can be used with the following command:

    $ peakrdl python-simple input_file.rdl -o output_interface.py

## Documentation

See the [PeakRDL-Python-simple
Documentation](http://peakrdl-python-simple.readthedocs.io) for more details.

