semvec/pypi-packages huggingface dataset:
pynqutils-git 0.1.1
Utilities for PYNQ
License: BSD 3-Clause
Requires Python: >=3.5.2

![pynq_logo](https://github.com/Xilinx/PYNQ/raw/master/logo.png)
### version 0.1.1 

PYNQ-Utils is a repository containing utilities used in various other repos and projects across the PYNQ ecosystem. The tools are categorized into three sections:
* ``/runtime`` for utilities that are used in the PYNQ runtime, such as ```ReprDict``` which is used to pretty print dictionaries in Jupyter.
* ``/setup_utils`` for utilities that are used in the construction of python packages and to help in managing the PYNQ environment.
* ``/build_utils`` for utilities that are mainly used at build time when __constructing Overlays__. However, there are some utilities here that overlap with other sections, such as the XSAParser, which is also used by the PYNQ runtime for parsing the design metadata and bitstream.

## QuickStart

To install PYNQ-Utils use the following command:
```Bash
python3 -m pip install pynqutils 
```

## setup.py example

One place where PYNQ-Utils is frequently used is in the ```setup.py``` of projects that build upon PYNQ. 
```python
from pynqutils.setup_utils import build_py, find_version, extend_package, get_platform

data_files = []
extend_package(path=os.path.join(module_name, "notebooks"), data_files=data_files)

setup(
    name="pynq_helloworld",
    version=find_version('{}/__init__.py'.format("pynq_helloworld")),
    description="PYNQ example design supporting edge and PCIE boards",
    long_description="PYNQ HelloWorld example design",
    long_description_content_type='text/markdown',
    author='Xilinx PYNQ Development Team',
    author_email="pynq_support@xilinx.com",
    url='https://github.com/Xilinx/PYNQ-HelloWorld.git',
    license='BSD 3-Clause License',
    packages=find_packages(),
    package_data={
        "": data_files,
    },
    python_requires=">=3.6.0",
    install_requires=[
        "pynqutils",
        "matplotlib",
        "ipython"
    ],
    entry_points={
        "pynq.notebooks": [
            "pynq-helloworld = {}.notebooks.{}".format( "pynq_helloworld", get_platform())
        ]
    },
    cmdclass={"build_py": build_py}
)
```
As can be seen from the above snippet PYNQ-Utils contains lots of handy utilities for creating a ```setup.py``` script. Some examples from above are:
* ```find_version``` - used to find the verstion of the current project from the source
* ```extend_package``` - used to search directories to find files and directories to add to the package.
* ```get_platform``` - used to determine the current platform that the project is being installed onto, for instance, ```edge``` or ```pcie```.

A complete example of a ```setup.py``` using PYNQ-Utils can be found [here](https://github.com/STFleming/PYNQ-HelloWorld/blob/tests/setup.py).
pynqmetadata-git 0.1.8
Extensible, Modular, Metadata layer for PYNQ projects
License: BSD 3-Clause
Requires Python: >=3.8

![pynq_logo](https://github.com/Xilinx/PYNQ/raw/master/logo.png)
### version 0.1.8

PYNQ-Metadata is an open-source project from Xilinx and is part of the PYNQ ecosystem. It's aims are to provide an abstract description of reconfigurable system designs. It is currently used internally within PYNQ to represent the hardware design currently configured in the Programmable Logic of Zynq-based devices. It is currently in pre-release.  

## Quick Start
PYNQ-Metadata can parse the design of a system in the following formats:
* A HWH file
* An XSA file
* A JSON PYNQ-Metadata description 

To install PYNQ-Metadata use the following command:
```
python3 -m pip install pynqmetadata 
```

To parse a design use the following python commands:
```python
from pynqmetadata.frontends import Metadata
md = Metadata('xsa_file.xsa')
md = Metadata('hwh_file.hwh')
md = Metadata('pynq_metadata_json_file.json')
```

Once a design has been parsed it can then be easily walked, searched, modified, extended, and much more. 

## Tutorials
__Coming soon:__ Documentation on how to use PYNQ-Metadata to manipulate and inspect designs.

## Python Source Code

All python code for the ``PYNQ-Metadata`` package can be found in the `/pynqmetadata` folder.

* `pynqmetadata/frontends` -- contains the frontend parsers for taking an XSA, HWH, or more into the PYNQMetadata format. 
* `pynqmetadata/models` -- contains the class hierarchy for the internal object model of a PYNQMetadata representation.
* `pynqmetadata/errors` -- contains the exception classes.


## Changelog
* v0.1.8 : Add parsing of clock select
* v0.1.7 : Relaxing constraint on address mapping due to issues with rfsoc4x2_base parsing. 
* v0.1.6 : Python3.11 support added (Thanks @modularizer) 
* v0.1.5 : Prevent parsing error when external AXI ports are present in the design. 
* v0.1.4 : Fixing runtime metadata views for when the PS is contained within a hierarchy. Relaxing the Python version constraint (for x86). 
* v0.1.3 : Fixing python version requirement 
* v0.1.2 : Fixed issue where custom IP was being interpreted as an empty hierarchy
* v0.1.1 : Fixed circular dependency issue with PYNQ-Utils