Skip to content

Commit

Permalink
updating library-development-related docs to reflect use of poetry
Browse files Browse the repository at this point in the history
  • Loading branch information
jclerman committed Jan 4, 2023
1 parent c873a53 commit 7341453
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ or

or from your locally cloned repository you can install it with one of the following options:

$ python setup.py install
$ poetry install # installs into a poetry-managed venv

or

Expand Down Expand Up @@ -182,21 +182,22 @@ Multiple other projects are contained within the RDFlib "family", see <https://g

Run the test suite with `pytest`.
```shell
pytest
poetry install
poetry run pytest
```

### Running test coverage on the host with coverage report

Run the test suite and generate a HTML coverage report with `pytest` and `pytest-cov`.
```shell
pytest --cov
poetry run pytest --cov
```

### Viewing test coverage

Once tests have produced HTML output of the coverage report, view it by running:
```shell
pytest --cov --cov-report term --cov-report html
poetry run pytest --cov --cov-report term --cov-report html
python -m http.server --directory=htmlcov
```

Expand Down
2 changes: 1 addition & 1 deletion docs/developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Specific tests can be run by file name. For example:

.. code-block:: console
$ poetry run test/test_graph/test_graph.py
$ poetry run pytest test/test_graph/test_graph.py
For more extensive tests, including tests for the `berkleydb
<https://www.oracle.com/database/technologies/related/berkeleydb.html>`_
Expand Down

0 comments on commit 7341453

Please sign in to comment.