https://github.com/fair2-for-research-software/python-testing-for-research
A training course on the practical use of tests in research software.
https://github.com/fair2-for-research-software/python-testing-for-research
ci continuous-integration english fair fair4rs lesson pre-alpha python python-testing research research-software rse software software-testing testing unit-testing unit-tests
Last synced: about 2 months ago
JSON representation
A training course on the practical use of tests in research software.
- Host: GitHub
- URL: https://github.com/fair2-for-research-software/python-testing-for-research
- Owner: FAIR2-for-research-software
- License: other
- Created: 2024-03-08T11:54:34.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-05T16:41:11.000Z (4 months ago)
- Last Synced: 2025-02-05T17:29:27.738Z (4 months ago)
- Topics: ci, continuous-integration, english, fair, fair4rs, lesson, pre-alpha, python, python-testing, research, research-software, rse, software, software-testing, testing, unit-testing, unit-tests
- Language: Python
- Homepage: https://fair2-for-research-software.github.io/python-testing-for-research/
- Size: 6.24 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Python testing for research
A short course on the basics of software testing in Python using the `pytest` library.
This lesson uses [The Carpentries Workbench][workbench] template.
## Course Description
Whether you are a seasoned developer or just write the occasional script, it's important to know that your code does what you intend, and will continue to do so as you make changes.
Software testing is a methodology of automatically ensuring that your code works correctly, without having to go back and manually verify after each change.
This course seeks to provide you with conceptual understanding and the tools you need to start ensuring the robustness of your code.
### Contents
- Basic tests
- Running a test suite & understanding outputs
- Best practices
- Testing for errors
- Testing data structures
- Fixtures
- Parametrisation
- Testing file outputs
- Continuous integration & automatic test-running with GitHub
## Contributions
Contributions are welcome, please refer to the [contribution guidelines](CONTRIBUTING.md) of how to do so and ensure that you adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
### Build the lesson locally
To render the lesson locally, you will need to have [R][r] installed. Instructions for using R with the Carpentries template is [available](https://carpentries.github.io/workbench/#installation) but some additional setps have been taken to make sure the enivronment is reproducible using the [`{renv}`](https://rstudio.github.io/renv/articles/renv.html) package and an `renv.lockfile` is included which allows the environment to be re-created along with dependencies.
After cloning the repository, you can set up the `renv` and install all packages with:
``` r
renv::restore()
# Optionally update packages
renv::update()
```
Once you have installed the dependencies, you can render the pages locally by starting R in the project root and running:
``` r
sandpaper::serve()
```
This will build the pages and start a local web-server in R and open it in your browser. These pages are "live" and will respond to local file changes if you save them.
[git]: https://git-scm.com
[r]: https://www.r-project.org/
[workbench]: https://carpentries.github.io/workbench/