| Name | canary-wm JSON |
| Version |
25.8.28
JSON |
| download |
| home_page | None |
| Summary | canary: application testing with Python |
| upload_time | 2025-08-28 15:19:20 |
| maintainer | None |
| docs_url | None |
| author | Tim Fuller, Others (See AUTHORS) |
| requires_python | >=3.10 |
| license | Copyright 2025 National Technology & Engineering Solutions of Sandia, LLC (NTESS). Under the terms
of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software.
The MIT License (MIT)
Copyright (c) 2025 National Technology & Engineering Solutions of Sandia, LCC (NTESS)
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 |
test
unittest
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CANARY
`canary` is a python package providing an application testing framework designed to test scientific applications.
- **Documentation:** https://canary-wm.readthedocs.io/en/production/
`canary` is inspired by [vvtest](https://github.com/sandialabs/vvtest) and designed to run tests on diverse hardware from laptops to super computing clusters. `canary` not only validates the functionality of your application but can also serve as a workflow manager for analysts. A "test" is an executable script with extension `.pyt` or `.vvt`. If the exit code upon executing the script is `0`, the test is considered to have passed, otherwise a non-passing status will be assigned. `canary`'s methodology is simple: given a path on the filesystem, `canary` recursively searches for test scripts, sets up the tests described in each script, executes them, and reports the results.
`canary` offers several advantages over similar testing tools:
**Speed**: Hierarchical parallelism is used to run tests asynchronously, optimizing resource utilization and speeding up the testing process.
**Python**: Test files are written in [Python](python.org), giving developers access to the full Python ecosystem.
**Integration**: `canary` integrates with popular developer tools like [CMake](cmake.org), [CDash](cdash.org) and [GitLab](gitlab.com), streamlining the testing and continuous integration (CI) processes.
**Extensibility**: `canary` can be extended through user plugins, allowing developers to customize their test sessions according to their specific needs.
## Requirements
Python 3.10+
## Install
`canary` is distributed as a python library and is most easily installed via `pip` (or other compatible tool):
To install the latest development version, execute:
```console
python3 -m pip install "canary-wm@git+ssh://git@github.com/sandialabs/canary"
```
To install the latest production version, execute:
```console
python3 -m pip install canary-wm
```
## Developers
For developers wanting to make modifications and/or contributions to `canary`, install in editable mode:
```console
python3 -m pip install -e git+https://github.com/sandialabs/canary#egg=canary-wm[dev]
```
which will leave a copy of `canary` in your Python distribution's `$prefix/src` directory. Edits made to the source will be immediately visible by the Python interpreter. Alternatively, the source can be cloned and then installed in editable mode:
```console
git clone git@github.com:sandialabs/canary
cd canary
python3 -m pip install --editable .[dev]
```
To format code and run `canary`'s internal tests, execute
```console
./bin/pre-commit
```
## License
Canary is distributed under the terms of the MIT license, see [LICENSE](https://github.com/sandialabs/canary/blob/main/LICENSE) and [COPYRIGHT](https://github.com/sandialabs/canary/blob/main/COPYRIGHT).
SPDX-License-Identifier: MIT
SCR#:3170.0
Raw data
{
"_id": null,
"home_page": null,
"name": "canary-wm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "test, unittest",
"author": "Tim Fuller, Others (See AUTHORS)",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/c4/85/b94844c735d7cce066e8f5e70ac6e51c0293d7f2ecf68be7dede7a7eefeb/canary_wm-25.8.28.tar.gz",
"platform": null,
"description": "# CANARY\n\n`canary` is a python package providing an application testing framework designed to test scientific applications.\n\n- **Documentation:** https://canary-wm.readthedocs.io/en/production/\n\n `canary` is inspired by [vvtest](https://github.com/sandialabs/vvtest) and designed to run tests on diverse hardware from laptops to super computing clusters. `canary` not only validates the functionality of your application but can also serve as a workflow manager for analysts. A \"test\" is an executable script with extension `.pyt` or `.vvt`. If the exit code upon executing the script is `0`, the test is considered to have passed, otherwise a non-passing status will be assigned. `canary`'s methodology is simple: given a path on the filesystem, `canary` recursively searches for test scripts, sets up the tests described in each script, executes them, and reports the results.\n\n`canary` offers several advantages over similar testing tools:\n\n**Speed**: Hierarchical parallelism is used to run tests asynchronously, optimizing resource utilization and speeding up the testing process.\n\n**Python**: Test files are written in [Python](python.org), giving developers access to the full Python ecosystem.\n\n**Integration**: `canary` integrates with popular developer tools like [CMake](cmake.org), [CDash](cdash.org) and [GitLab](gitlab.com), streamlining the testing and continuous integration (CI) processes.\n\n**Extensibility**: `canary` can be extended through user plugins, allowing developers to customize their test sessions according to their specific needs.\n\n## Requirements\n\nPython 3.10+\n\n## Install\n\n`canary` is distributed as a python library and is most easily installed via `pip` (or other compatible tool):\n\nTo install the latest development version, execute:\n\n```console\npython3 -m pip install \"canary-wm@git+ssh://git@github.com/sandialabs/canary\"\n```\n\nTo install the latest production version, execute:\n\n```console\npython3 -m pip install canary-wm\n```\n\n## Developers\n\nFor developers wanting to make modifications and/or contributions to `canary`, install in editable mode:\n\n```console\npython3 -m pip install -e git+https://github.com/sandialabs/canary#egg=canary-wm[dev]\n```\n\nwhich will leave a copy of `canary` in your Python distribution's `$prefix/src` directory. Edits made to the source will be immediately visible by the Python interpreter. Alternatively, the source can be cloned and then installed in editable mode:\n\n```console\ngit clone git@github.com:sandialabs/canary\ncd canary\npython3 -m pip install --editable .[dev]\n```\n\nTo format code and run `canary`'s internal tests, execute\n\n```console\n./bin/pre-commit\n```\n\n## License\n\nCanary is distributed under the terms of the MIT license, see [LICENSE](https://github.com/sandialabs/canary/blob/main/LICENSE) and [COPYRIGHT](https://github.com/sandialabs/canary/blob/main/COPYRIGHT).\n\nSPDX-License-Identifier: MIT\n\nSCR#:3170.0\n",
"bugtrack_url": null,
"license": "Copyright 2025 National Technology & Engineering Solutions of Sandia, LLC (NTESS). Under the terms\n of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software.\n \n The MIT License (MIT)\n \n Copyright (c) 2025 National Technology & Engineering Solutions of Sandia, LCC (NTESS)\n \n Permission is hereby granted, free of charge, to any person obtaining a copy of this software and\n associated documentation files (the \"Software\"), to deal in the Software without restriction,\n including without limitation the rights to use, copy, modify, merge, publish, distribute,\n sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all copies or\n substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT\n NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\n NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\n DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT\n OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n ",
"summary": "canary: application testing with Python",
"version": "25.8.28",
"project_urls": {
"Documentation": "https://canary-wm.readthedocs.io/en/production/",
"Issues": "https://github.com/sandialabs/canary/issues",
"Repository": "https://github.com/sandialabs/canary"
},
"split_keywords": [
"test",
" unittest"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ca8f7afa41fa5b8aece64a14f78577174c1a60ed60a8cb5087fb1230179da864",
"md5": "95906c7c27127c6866a331d1a2f777c4",
"sha256": "cc0aefcc21a6b0e3168d4437f1db9495e1998b8d6f7b1233e7780f9e57e4304b"
},
"downloads": -1,
"filename": "canary_wm-25.8.28-py3-none-any.whl",
"has_sig": false,
"md5_digest": "95906c7c27127c6866a331d1a2f777c4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 363819,
"upload_time": "2025-08-28T15:19:18",
"upload_time_iso_8601": "2025-08-28T15:19:18.554774Z",
"url": "https://files.pythonhosted.org/packages/ca/8f/7afa41fa5b8aece64a14f78577174c1a60ed60a8cb5087fb1230179da864/canary_wm-25.8.28-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c485b94844c735d7cce066e8f5e70ac6e51c0293d7f2ecf68be7dede7a7eefeb",
"md5": "6159b0737871b1ebeb6696708adc1628",
"sha256": "84c2efeeae3dd9fc51adc6dbf6a2a331c45bff937fcf6201d341498cba878113"
},
"downloads": -1,
"filename": "canary_wm-25.8.28.tar.gz",
"has_sig": false,
"md5_digest": "6159b0737871b1ebeb6696708adc1628",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 6413693,
"upload_time": "2025-08-28T15:19:20",
"upload_time_iso_8601": "2025-08-28T15:19:20.713606Z",
"url": "https://files.pythonhosted.org/packages/c4/85/b94844c735d7cce066e8f5e70ac6e51c0293d7f2ecf68be7dede7a7eefeb/canary_wm-25.8.28.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-28 15:19:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sandialabs",
"github_project": "canary",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "canary-wm"
}
