You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-19Lines changed: 25 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,18 @@
2
2
3
3
A short course on the basics of software testing in Python using the `pytest` library.
4
4
5
-
This lesson uses [The Carpentries Workbench][workbench] template.
5
+
This lesson uses [The Carpentries Workbench](https://carpentries.github.io/workbench/) template.
6
6
7
7
## Course Description
8
8
9
-
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.
9
+
Whether you are a seasoned developer or just write the occasional script, it's important to know that your code does
10
+
what you intend, and will continue to do so as you make changes.
10
11
11
-
Software testing is a methodology of automatically ensuring that your code works correctly, without having to go back and manually verify after each change.
12
+
Software testing is a methodology of automatically ensuring that your code works correctly, without having to go back
13
+
and manually verify after each change.
12
14
13
-
This course seeks to provide you with conceptual understanding and the tools you need to start ensuring the robustness of your code.
15
+
This course seeks to provide you with conceptual understanding and the tools you need to start ensuring the robustness
16
+
of your code.
14
17
15
18
### Contents
16
19
@@ -26,28 +29,31 @@ This course seeks to provide you with conceptual understanding and the tools you
26
29
27
30
## Contributions
28
31
29
-
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).
32
+
Contributions are welcome, please refer to the [contribution guidelines](CONTRIBUTING.md) of how to do so and ensure
33
+
that you adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
30
34
31
35
### Build the lesson locally
32
-
33
-
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.
36
+
<!-- markdownlint-disable MD053 -->
37
+
To render the lesson locally, you will need to have [R](https://www.r-project.org/) installed. Instructions for using
38
+
R with the Carpentries template is [available](https://carpentries.github.io/workbench/#installation) but some
39
+
additional setps have been taken to make sure the environment is reproducible using the
40
+
[`{renv}`](https://rstudio.github.io/renv/articles/renv.html) package and an `renv.lockfile` is included which allows
41
+
the environment to be re-created along with dependencies.
34
42
35
43
After cloning the repository, you can set up the `renv` and install all packages with:
36
-
```r
44
+
45
+
```r
37
46
renv::restore()
38
-
# Optionally update packages
47
+
39
48
renv::update()
40
49
```
41
-
Once you have installed the dependencies, you can render the pages locally by starting R in the project root and running:
42
-
```r
43
-
sandpaper::serve()
44
-
```
45
-
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.
0 commit comments