We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 3eddfd9 commit fac1084Copy full SHA for fac1084
1 file changed
README.md
@@ -34,4 +34,9 @@ A simple REST API built with FastAPI to manage sensor values of IOT devices and
34
35
### Running
36
- 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.
+- 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