Skip to content

Commit 3ad7648

Browse files
Add instructions for running tests.
1 parent 5bf3ba6 commit 3ad7648

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,6 @@ We built this API to show how the technology can fight this and other crises, an
1111
### Use the API
1212
To classify your own images, you can use the live API: use the link [here](https://fire-detection-api.herokuapp.com/docs) to read the documentation and send requests.
1313

14-
### Run the Tests
15-
TBD
16-
1714
### Running Locally
1815

1916
#### Using Docker
@@ -35,6 +32,12 @@ And then run the app using `uvicorn` in the Command Line:
3532
(env) $ uvicorn app.main:app --reload
3633
```
3734

35+
### Run the Tests
36+
To run the tests, you will first need to set up a Python virtual environment to run this project locally (see above). Then you can run the automated tests from the root directory, using the command line:
37+
```
38+
(env) $ pytest
39+
```
40+
3841
## The Data and the Model
3942
The image dataset and model used for the production API will be documented on the [Releases](https://github.com/UPstartDeveloper/Fire-Detection-API/releases) page of this repository.
4043

0 commit comments

Comments
 (0)