ethancloin/plantdaddy-backend

REST API for PlantDaddy web app. Leverages a modern, typed Python stack.

PlantDaddy-Backend

REST API for PlantDaddy web app. Leverages a modern, typed Python stack.

Value Prop:

One place with all the info you need to keep the plant alive

Features:

• Name, classify, categorize, and perform lookups for plants
• Create PlantGroups
• Schedule events for watering/care

Stack:

• FastAPI (api framework)
• SQLModel (orm)
• Poetry (dependencies/venv)
• Black (formatting)
• Flake8 (linting)
• MyPy (strong typing)

Contributor Quickstart

Prerequisite: Poetry installation

(VSCode)

• install Python/Pylance/Toml extensions
• update poetry virtual environments setting to keep it in the project instead of default location by running: poetry config virtualenvs.in-project true

setup virtual environment

• Create Virtual Environments with poetry: poetry env use python3.10 and poetry env use python3.9.
• Activate the venv using poetry shell
• Install the packages listed in pyproject.toml into your venv using poetry install.

setup database

• Create a local SQLite database file by creating a file ending in .db.
• Create a file ".env" in the project root and add the absolute path to your .db file to a variable SQLITE_FILE.

run the server

• Start the server by running python3 -m app.console from the project root.
• Alternatively, run from the command line with uvicorn app.api.v1.endpoints.plant:app --reload
• Test the endpoints by going to the localhost link which appears in the console and appending "/docs" to the URL

plantdaddy-backend's Issues

Watering Frequency Feature

Summary

Allow user to assign a WateringFrequency to their plants. After x days have passed, remind user to water.

Database Relationship

WateringFrequency can exist as a standalone Enum
Each Plant can have either zero or one WateringFrequency

User Stories v1

• Any Plant with a given WateringFrequency will follow the 'standard' schedule
  The 'standard' schedule determines whether the current day needs_water by considering whether the selected frequency is evenly divisible by the current day of the year.

EG: BIMONTHLY frequency is assigned, which has a value of 14. The current date is January 28, the 28th day of the year. Since 28 mod 14 == 0, any plant on the standard schedule should be updated to needs_water=True.

• User can mark an individual plant as watered from the SinglePlant view
• User can mark all plants as watered from the Home view
• User can mark all plants matching the given filter as watered from the Home view
• Updating the needs_water status will also update the last_watered day.

Potential Future Development

• Track and report WateringHistory for each plant
• Support users providing a custom start date for their watering frequency
• Dynamically reschedule watering events if the user marks a plant as watered on an unexpected date
• Send Push/Email notifications when scheduled waterings are due

Create Test Data

Summary

Create 5+ rows of plants which can be included in the database upon startup to make testing more consistent. Will be useful to test out parts of the frontend with real data.

Fatal Import Errors

unable to properly run uvicorn server due to import issues with both the models and db packages.