Skip to content

Commit fac1084

Browse files
committed
Add notes on how to run tests and format the code to the README
1 parent 3eddfd9 commit fac1084

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,9 @@ A simple REST API built with FastAPI to manage sensor values of IOT devices and
3434

3535
### Running
3636
- To run the api use the following command: `uvicorn api.main:app --reload`
37-
- on `localhost:8000/docs` you will get detailed documentation over all endpoints.
37+
- on `localhost:8000/docs` you will get detailed documentation over all endpoints.
38+
39+
## Development notes
40+
- Code should always be formatted with `black .` and `isort .`
41+
- Tests can be run with coverage with the following command: `pytest tests --cov=api --cov-report=html`
42+
- A html report will be generated under `htmlcov/index.html`

0 commit comments

Comments
 (0)