Skip to content

Commit 7f9a76e

Browse files
authored
Update README.md
1 parent 5672c64 commit 7f9a76e

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,4 +286,25 @@ cloud.spheres.update_sync()
286286
Make sure to see the examples above!
287287

288288
## Testing
289-
Tests coming soon!
289+
To run the tests using tox install tox first by running:
290+
```console
291+
$ pip install tox
292+
```
293+
To execute the tests cd to the project folder and run:
294+
```console
295+
$ tox
296+
```
297+
To see which parts of the code are covered by the tests, a coverage report is generated after the tests have been successfull.<br>
298+
To see the coverage report run:
299+
```console
300+
$ coverage report
301+
```
302+
If you like to get a better overview of the test you can generate a HTML file like so:
303+
```console
304+
$ coverage html
305+
```
306+
To view your html file directly on Linux:
307+
```console
308+
$ ./htmlcov/index.html
309+
```
310+
On Windows simply navigate to the htmlcov folder inside the project folder, and double-click index.html. It will be executed in your selected browser.

0 commit comments

Comments
 (0)