Turfcoach

A tool to schedule maintenance and replacement of grass in turfs depending on weather conditions.

Installation

# Install dependencies
pip install -r requirements.txt

Running the Application

After adding configuring the database connection string to a new file called .env run the following command to run the server:

# Start the FastAPI server
uvicorn main:app --reload

This will start the FastAPI application with live reloading enabled.

Then navigate to http://127.0.0.1:8000/docs to view the API docs and test the endpoint.

Running Tests

# Run pytest
pytest

TODO

• Add more tests to cover more cases.
• Use mock db calls in unit tests.
• Add setup/teardown to support atomic integration tests.

Built With

• FastAPI - The web framework used
• pytest - The testing framework used
• Bunnet - The ODM used