Metadata-Version: 2.1
Name: roast
Version: 2.1.0
Summary: Randomized Okaying Across System Topologies (ROAST) Python Framework
Home-page: https://github.com/Xilinx/roast
Author: Ching-Hwa Yu
Author-email: chinghwa@xilinx.com
License: MIT
Keywords: roast
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
Requires-Dist: python-configuration[toml,yaml] (==0.8.2)
Requires-Dist: stevedore (>=3.0)
Requires-Dist: gitpython
Requires-Dist: pexpect
Requires-Dist: pyyaml
Requires-Dist: mimesis
Requires-Dist: filelock
Requires-Dist: python-box
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-mock ; extra == 'dev'
Requires-Dist: pytest-black ; extra == 'dev'
Requires-Dist: pytest-freezegun ; extra == 'dev'
Requires-Dist: miniver ; extra == 'dev'

# ROAST
ROAST is an open-source Python framework that simplifies the development of complex validation test suites. To accomplish this, ROAST provides a collection of interfaces that allows test developers to build
test suites in a highly structured manner.

Key features:

- Compose systems from Xilinx or custom components
- Define systems composed from various configuration sources
- Heirarchical configuration system
- Randomized data provider for randomized testing
- Generic APIs for simplified usage and access
- Plugin system for extensibility

ROAST consists of three packages:

- roast: Core functionality that includes interfaces, plugin framework, configuration
  management, and more
- roast-xilinx (recommended: plugin for roast that includes Xilinx specific functionality such as
  board acquisition, PetaLinux building, Vitis wrapper, and more.
- pytest-roast (optional): plugin for pytest that includes pytest fixtures for accelerated test
  development when using pytest as a test runner. Features includes target automation, scenario
  generation, and configuration generation.

Example test flow with package breakdown:

![ROAST packages](images/roast_packages.png)


