| Name | constrainedrandom JSON |
| Version |
1.2.2
JSON |
| download |
| home_page | None |
| Summary | A library for creating and solving constrained randomization problems |
| upload_time | 2024-10-14 11:31:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8.3 |
| license | MIT License Copyright (c) 2023 Imagination Technologies Ltd. Copyright (c) 2024 Will Keen. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
constrained
constraint
random
randomization
verification
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `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`](https://docs.python.org/3/library/random.html) and [`constraint`](https://pypi.org/project/python-constraint/) packages, and aims to be as efficient as possible in a language like Python.
## Installation
```bash
$ pip install constrainedrandom
```
## Documentation
[Read the docs here](https://constrainedrandom.readthedocs.io/en/latest/)
To build the documentation yourself:
```bash
$ 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](https://pypi.org/project/constrainedrandom/).
Versioning attempts to follow [Semantic Versioning](https://semver.org/).
## 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.
## `TODO`
- Add proper CI using tox or similar, testing Python versions 3.8..current
- Add equivalent SystemVerilog testcases for benchmarking.
## Contact the author(s)
Will Keen - william.keen@imgtec.com
Raw data
{
"_id": null,
"home_page": null,
"name": "constrainedrandom",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8.3",
"maintainer_email": null,
"keywords": "constrained, constraint, random, randomization, verification",
"author": null,
"author_email": "Will Keen <willkeencodes@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/b6/04/2a9a8a7c7dffae880f7ae1e87463c041aa433477d9d41f2ab2143c2d01be/constrainedrandom-1.2.2.tar.gz",
"platform": null,
"description": "# `constrainedrandom`\n\nA package for creating and solving constrained randomization problems.\n\nUse this package to create SystemVerilog-style \"declarative\" randomizable objects in Python.\n\nThis is achieved by providing wrappers around the Python [`random`](https://docs.python.org/3/library/random.html) and [`constraint`](https://pypi.org/project/python-constraint/) packages, and aims to be as efficient as possible in a language like Python.\n\n\n## Installation\n\n```bash\n$ pip install constrainedrandom\n```\n\n## Documentation\n\n[Read the docs here](https://constrainedrandom.readthedocs.io/en/latest/)\n\nTo build the documentation yourself:\n```bash\n$ cd docs\n$ make html\n```\n\nThe index page is at `docs/_build/html/index.html` - you can open this in a web browser.\n\n## Tests and benchmarks\n\nPlease see `tests/README.md` and `benchmarks/README.md` for more information.\n\n## Releases/versioning\n\nReleases are created using tags from the repository and can be found on [PyPI](https://pypi.org/project/constrainedrandom/).\n\nVersioning attempts to follow [Semantic Versioning](https://semver.org/).\n\n## Contributions\n\nPlease feel free to contribute to the project, following these guidelines:\n- Please contribute by creating a fork and submitting a pull request.\n- Pull requests should be as small as possible to resolve the issue they are trying to address.\n- Pull requests must respect the goals of the library, as stated in the documentation.\n- Pull requests should maintain backwards compatibility at least as far as Python 3.8.\n- Pull requests should pass all the tests in the `tests/` directory. Run `python -m tests`.\n- 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`.\n- Pull requests should update the documentation for any added/changed functionality.\n\n## `TODO`\n - Add proper CI using tox or similar, testing Python versions 3.8..current\n - Add equivalent SystemVerilog testcases for benchmarking.\n\n## Contact the author(s)\n\nWill Keen - william.keen@imgtec.com\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Imagination Technologies Ltd. Copyright (c) 2024 Will Keen. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A library for creating and solving constrained randomization problems",
"version": "1.2.2",
"project_urls": {
"Bug Tracker": "https://github.com/will-keen/constrainedrandom/issues",
"Homepage": "https://github.com/will-keen/constrainedrandom"
},
"split_keywords": [
"constrained",
" constraint",
" random",
" randomization",
" verification"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e735647e705450033bcd13cfb494ae6ef8a2df403c0f362a2fddbd00498744f",
"md5": "9751f97cef3b6540d0014624d863e4bf",
"sha256": "728a2f321a6ab23e7d7127fdee2bd9faa76d9842f28b526fb7062dc8500f9437"
},
"downloads": -1,
"filename": "constrainedrandom-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9751f97cef3b6540d0014624d863e4bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.3",
"size": 31264,
"upload_time": "2024-10-14T11:31:52",
"upload_time_iso_8601": "2024-10-14T11:31:52.659012Z",
"url": "https://files.pythonhosted.org/packages/9e/73/5647e705450033bcd13cfb494ae6ef8a2df403c0f362a2fddbd00498744f/constrainedrandom-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b6042a9a8a7c7dffae880f7ae1e87463c041aa433477d9d41f2ab2143c2d01be",
"md5": "f5753cac37a019e8e67ec1528e3f53cb",
"sha256": "07093cca031149b1b972662f0022434fb75e54802c8307d6710546d09dc5ee6b"
},
"downloads": -1,
"filename": "constrainedrandom-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "f5753cac37a019e8e67ec1528e3f53cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.3",
"size": 60349,
"upload_time": "2024-10-14T11:31:54",
"upload_time_iso_8601": "2024-10-14T11:31:54.279015Z",
"url": "https://files.pythonhosted.org/packages/b6/04/2a9a8a7c7dffae880f7ae1e87463c041aa433477d9d41f2ab2143c2d01be/constrainedrandom-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-14 11:31:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "will-keen",
"github_project": "constrainedrandom",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "constrainedrandom"
}
