build: add postgresql db config (with peewee)

.env.example

@@ -15,3 +15,10 @@ SENTRY_DNS=
 
 # Log level to use, DEBUG by default in dev
 LOG_LEVEL=DEBUG
+
+# Postgres database
+POSTGRES_DB_NAME=open_prices
+POSTGRES_USER=open_prices_team
+POSTGRES_PASSWORD=password
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432

INSTALL.md

@@ -3,10 +3,12 @@
 ## Prerequisites
 
 - Python 3.10 (lower version may be OK, but untested)
-- pip
+- Postgresql 13 (lower version may be OK, but untested)
 
 ## Setup
 
+### Without Docker
+
 ```
 # clone repo
 git clone https://github.com/openfoodfacts/open-prices.git
@@ -22,6 +24,12 @@ source venv/bin/activate
 # install
 pip install -r requirements.txt
 
+# create Postgresql database
+psql -c "CREATE USER open_prices_team WITH PASSWORD 'password'"
+psql -c "CREATE DATABASE open_prices OWNER open_prices_team"
+psql -c "GRANT ALL PRIVILEGES ON DATABASE open_prices to open_prices_team"
+psql -c "ALTER USER open_prices_team CREATEROLE CREATEDB"
+
 # environment variables
 # make a copy of *.env.example* and rename it to *.env*
 ```

README.md

@@ -4,8 +4,9 @@ A REST API designed to interact with the Open Food Facts _Open Prices_ database.
 
 ## Dependencies
 
-* Python 3.12
+* Python 3.10
 * [FastAPI](https://fastapi.tiangolo.com/) framework
+* Postgresql 13
 
 ## How to install on your local machine
 

app/api.py

@@ -6,6 +6,7 @@
 from fastapi.responses import PlainTextResponse
 from fastapi.templating import Jinja2Templates
 from openfoodfacts.utils import get_logger
+from playhouse.postgres_ext import PostgresqlExtDatabase
 
 from app.config import settings
 from app.utils import init_sentry
@@ -32,6 +33,18 @@
 init_sentry(settings.sentry_dns)
 
 
+@app.on_event("startup")
+async def startup():
+    global db
+    db = PostgresqlExtDatabase(settings.postgres_db_name, user=settings.postgres_user, password=settings.postgres_password, host=settings.postgres_host, port=settings.postgres_port)
+    db.connect()
+
+
+@app.on_event("shutdown")
+async def shutdown():
+    db.close()
+
+
 @app.get("/", response_class=HTMLResponse)
 def main_page(request: Request):
     return templates.TemplateResponse(

app/config.py

@@ -1,6 +1,7 @@
 from enum import Enum
 
 from pydantic_settings import BaseSettings
+from pydantic_settings import SettingsConfigDict
 
 
 class LoggingLevel(Enum):
@@ -27,8 +28,15 @@ def to_int(self):
 
 
 class Settings(BaseSettings):
+    postgres_db_name: str
+    postgres_user: str
+    postgres_password: str
+    postgres_host: str
+    postgres_port: int = 5432
     sentry_dns: str | None = None
     log_level: LoggingLevel = LoggingLevel.INFO
 
+    model_config = SettingsConfigDict(env_file=".env", extra="ignore")
+
 
 settings = Settings()

requirements.txt

@@ -2,6 +2,7 @@ fastapi==0.103.1
 jinja2==3.1.2
 openfoodfacts==0.1.10
 peewee==3.17.0
+psycopg2-binary==2.9.9
 pydantic-settings==2.0.3
 requests==2.31.0
 sentry-sdk[fastapi]==1.31.0