Skip to content

Commit add6d35

Browse files
authored
Add better description to the tests (#31)
* Add better description to the tests * Update README.md
1 parent 97bf194 commit add6d35

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,18 @@ Ipyannotator provides a [simple API](https://palaimon.github.io/ipyannotator/nbs
3030

3131
### Run ipyannotator tests
3232

33-
The tests can be executed using `nbdev_test_nbs` on the terminal.
33+
Ipyannotator's tests are directly integrated in the Jupyter Notebooks that make up the libraries source code, this is a consequence of following the literate programming style made possible by the library `nbdev`. Tests can be executed by running `nbdev_test_nbs` on the terminal.
3434

35-
Ipyannotator notebooks contains the development dependencies: [pytest](https://docs.pytest.org/en/7.1.x/) and [ipytest](https://github.com/chmp/ipytest). Make sure this dependencies are installed to run the tests.
35+
When installing the repository using poetry, all dev dependencies are installed by default.
36+
37+
When using pip for installation make sure to install the two dev dependencies `pytest` and `ipytest`, with the versions listed in `pyproject.toml`, manually:
38+
39+
```shell
40+
pip install pytest
41+
pip install ipytest
42+
```
43+
44+
[Nbdev](https://nbdev.fast.ai/#A-Motivating-Example) uses comments on the Jupyter notebook cells, such as `#exports`, to output the library code, and cells without comments to be executed as tests. Nbdev by itself doesn't guarantee that the tests are self-contained, that's why Ipyannotator uses [pytest](https://docs.pytest.org/en/7.1.x/) and [ipytest](https://github.com/chmp/ipytest) as dev dependencies.
3645

3746
### Run ipyannotator as stand-alone web app using voila
3847

0 commit comments

Comments
 (0)