From cdcfba205d0fdf72c49127146f7a5586ee97970c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=8Dtalo=20Epif=C3=A2nio?= Date: Mon, 25 Jul 2022 04:46:24 -0300 Subject: [PATCH] Update test section (#34) * Update README.md --- README.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 06f5e42..e7df52e 100644 --- a/README.md +++ b/README.md @@ -30,18 +30,12 @@ Ipyannotator provides a [simple API](https://palaimon.github.io/ipyannotator/nbs ### Run ipyannotator tests -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. +To run Ipyannotator's tests: -When installing the repository using poetry, all dev dependencies are installed by default. - -When using pip for installation make sure to install the two dev dependencies `pytest` and `ipytest`, with the versions listed in `pyproject.toml`, manually: - -```shell -pip install pytest -pip install ipytest -``` - -[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. +1. Install [poetry](https://python-poetry.org/docs/#installation) +2. Create the test environment with `poetry install` +3. Activate the poetry environment using `poetry shell` +4. Run tests by executing `nbdev_test_nbs` ### Run ipyannotator as stand-alone web app using voila