https://github.com/vsoch/gridtest

grid parameters and testing for Python modules and functions
https://github.com/vsoch/gridtest

gridtest testing yaml

Last synced: about 1 month ago
JSON representation

grid parameters and testing for Python modules and functions

• Host: GitHub
• URL: https://github.com/vsoch/gridtest
• Owner: vsoch
• License: mpl-2.0
• Created: 2020-04-16T22:46:54.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-07-27T22:28:53.000Z (over 3 years ago)
• Last Synced: 2025-01-06T03:21:05.430Z (about 1 month ago)
• Topics: gridtest, testing, yaml
• Language: HTML
• Homepage: https://vsoch.github.io/gridtest/
• Size: 13.6 MB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
# GridTest

[![PyPI version](https://badge.fury.io/py/gridtest.svg)](https://badge.fury.io/py/gridtest)

[![DOI](https://zenodo.org/badge/256346804.svg)](https://zenodo.org/badge/latestdoi/256346804)

[![DOI](https://joss.theoj.org/papers/10.21105/joss.02284/status.svg)](https://doi.org/10.21105/joss.02284)

Simple grid parameterization and testing setup for Python functions and modules.

See [Documentation](https://vsoch.github.io/gridtest/) to get started.

![docs/assets/img/logo/gridtest.gif](https://raw.githubusercontent.com/vsoch/gridtest/master/docs/assets/img/logo/gridtest.gif)

## Overview 

GridTest is a library that specializes in generating [parameter grids](https://vsoch.github.io/gridtest/#parameterization). The grids are most obviously used for testing, but can extend to other use cases.

In the context of testing, GridTest makes it easy to discover functions,

classes, and arguments for your python scripts or modules, and then generate

a template for you to easily populate. Outside of testing, you can define

grids that are version controlled, programatically defined with functions,

and easy to interact with from the command line or Python interpreter.

You might be interested in GridTest if you need:

   - low overhead tests for Python scripts and small packages

   - to generate input data for reproducible computations

To learn more, it's recommended to reference the [documentation](https://vsoch.github.io/gridtest/),

take a look at the [getting started](https://vsoch.github.io/gridtest/getting-started/index.html) pages,

or browse one of the many [tutorials](https://vsoch.github.io/gridtest/tutorials/index.html) available.

 * Free software: MPL 2.0 License

## Support

If you have any questions or requests for examples or tutorials, please don't hesitate

to [open an issue](https://github.com/vsoch/gridtest/issues).

## Contributing

Please see the [documentation contributing guide](https://vsoch.github.io/gridtest/contributing/index.html)

for details on how to contribute to documentation or code, or the GitHub [CONTRIBUTING.md](.github/CONTRIBUTING.md) 

for a list of checks when opening a pull request.

## Known Issues 

The following are known to not work, and development will depend on how useful

the average user will assess each of these points. The developer @vsoch has not

added them yet because she doesn't think them overall useful.

 - support for system libraries (e.g., sys) or anything without a filename in site-packages