constrainedrandom

A package for creating and solving constrained randomization problems.

Use this package to create SystemVerilog-style "declarative" randomizable objects in Python.

This is achieved by providing wrappers around the Python random and constraint packages, and aims to be as efficient as possible in a language like Python.

Installation

$ pip install constrainedrandom

Documentation

Read the docs here

To build the documentation yourself:

$ cd docs
$ make html

The index page is at docs/_build/html/index.html - you can open this in a web browser.

Tests and benchmarks

Please see tests/README.md and benchmarks/README.md for more information.

Releases/versioning

Releases are created using tags from the repository and can be found on PyPI.

Versioning attempts to follow Semantic Versioning.

See CHANGELOG.md for the changes in each release.

Contributions

Please feel free to contribute to the project, following these guidelines:

• Please contribute by creating a fork and submitting a pull request.
• Pull requests should be as small as possible to resolve the issue they are trying to address.
• Pull requests must respect the goals of the library, as stated in the documentation.
• Pull requests should maintain backwards compatibility at least as far as Python 3.8.
• Pull requests should pass all the tests in the tests/ directory. Run python -m tests.
• Pull requests should take care not to make performance worse except for cases which require bug fixes. Run python -m tests and python -m benchmarks.
• Pull requests should update the documentation for any added/changed functionality.
• Pull requests should add an entry to the [Unreleased] section of CHANGELOG.md.

Contact the author(s)

Will Keen - willkeencodes@gmail.com