andrei-stoica
/
recipe-graph
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated readme

This commit is contained in:
Andrei Stoica 2023-05-17 09:48:00 -04:00
parent 76e0438062
commit e6d150421f
1 changed files with 5 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -88,9 +88,13 @@ docker-compose -p recipe-test up
running tests running tests
```sh ```sh
pytest pytest --cov=src/recipe_graph --cov-report lcov --cov-report html
``` ```
The html report is under `htmlcov/` and can be viewed through any browser.
The `lcov` file can be used for the [Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters)
plugin for VS Code to view coverage in your editor.
**WARNINING**: If you get `ERROR at setup of test_db_connection` and **WARNINING**: If you get `ERROR at setup of test_db_connection` and
`ERROR at setup of test_db_class_creation`, please check if testing database is `ERROR at setup of test_db_class_creation`, please check if testing database is
already initiated. Testing is destructive and should be done on a fresh database. already initiated. Testing is destructive and should be done on a fresh database.
@ -105,16 +109,6 @@ docker-compose -p recipe-test down
Test are written in pytest framework. Currently focused on unittest and code Test are written in pytest framework. Currently focused on unittest and code
coverage. Integration tests to come. coverage. Integration tests to come.
To run test use:
```sh
pytest --cov=src/recipe_graph --cov-report lcov --cov-report html
```
The html report is under `htmlcov/` and can be viewed through any browser.
The `lcov` file can be used for the [Coverage Gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters)
plugin for VS Code to view coverage in your editor.
## TODO ## TODO
> ☑ automate scraping\ > ☑ automate scraping\
> ☑ extracting quantity and name (via regex)\ > ☑ extracting quantity and name (via regex)\