Scaffold FastAPI + SQLModel + Alembic project, Postgres-backed
Config-driven DATABASE_URL shared by the app and Alembic's env.py (fixes v1's config drift), psycopg3 driver, auto-discovering app/models package for SQLModel.metadata, and a /health endpoint that exercises the DB dependency end-to-end. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
commit
589dcbcdf5
18 changed files with 1729 additions and 0 deletions
2
.env.example
Normal file
2
.env.example
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
DATABASE_URL=postgresql+psycopg://user:password@localhost:5432/vinindkoeb
|
||||
ENVIRONMENT=development
|
||||
24
.gitignore
vendored
Normal file
24
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
# Python
|
||||
__pycache__/
|
||||
*.py[oc]
|
||||
*.egg-info/
|
||||
build/
|
||||
dist/
|
||||
|
||||
# venv / uv
|
||||
.venv/
|
||||
|
||||
# Env / secrets
|
||||
.env
|
||||
|
||||
# DB
|
||||
*.db
|
||||
*.sqlite3
|
||||
|
||||
# Editors / OS
|
||||
.vscode/
|
||||
.idea/
|
||||
.DS_Store
|
||||
|
||||
# Test cache
|
||||
.pytest_cache/
|
||||
1
.python-version
Normal file
1
.python-version
Normal file
|
|
@ -0,0 +1 @@
|
|||
3.13
|
||||
85
CLAUDE.md
Normal file
85
CLAUDE.md
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
# Fælles Vinindkøb — Projektplan
|
||||
|
||||
## Formål
|
||||
Erstatte manuel administration (regneark til betalingstracking, direkte
|
||||
databaseredigering for nye runder/deltagere/vine) med en rigtig
|
||||
admin-backend, samt automatisk betalings-mail til deltagere. Arkitekturen
|
||||
designes fra start til at kunne understøtte flere organisationer (fx
|
||||
vinbonden Horcher-familiens egne ruter i Frankrig/Belgien), selvom kun
|
||||
én organisation/rute er i drift i dag.
|
||||
|
||||
## Tech stack
|
||||
- Backend: FastAPI + SQLModel + PostgreSQL + Alembic (migrations)
|
||||
- Frontend: React (admin-UI) + eksisterende offentlige bestillingsside
|
||||
(fortsat intet login for deltagere)
|
||||
- Mail: SMTP-udbyder — afklares
|
||||
|
||||
## Datamodel
|
||||
|
||||
- **WineCategory** — global, delt af ALLE organisationer/ruter
|
||||
(samme vinbonde, samme kategoristruktur: TRADITION, SELECTION,
|
||||
LES IMPERTINENTS, GRANDS CRUS, VENDANGES TARDIVES, CREMANT, MAGNUM,
|
||||
SANS ALCOOL osv.)
|
||||
- navn, sortering
|
||||
|
||||
- **Organization** — administrativ gruppe (fx "Fælles Vinindkøb DK",
|
||||
"Horcher Frankrig")
|
||||
- navn
|
||||
|
||||
- **User** — admin-login, tilhører en Organization
|
||||
- simpelt login v1 (password-hash + session/JWT), struktureret så
|
||||
passkey/WebAuthn kan tilføjes senere uden brud
|
||||
|
||||
- **Route** — tilhører en Organization (fx "Tyskland" for jer;
|
||||
"Belgique" / "Paris" / "Massif Central" for Horcher-familien)
|
||||
- navn, mødested/kontaktperson/telefon (fritekst, forudfyldes fra
|
||||
forrige runde)
|
||||
|
||||
- **Participant** — tilhører en Route
|
||||
- navn, mail, telefon, is_active
|
||||
|
||||
- **PurchaseRound** — tilhører en Route
|
||||
- sæson (forår/efterår), år, status (kladde/åben/lukket)
|
||||
- eur_dkk_rate (valgfri — ikke alle organisationer skal omregne)
|
||||
- intro_text, pickup_info_text (forudfyldes fra forrige runde,
|
||||
kun dato/sæson skal typisk rettes)
|
||||
|
||||
- **WineOffering** — tilhører PurchaseRound + (global) WineCategory
|
||||
- navn (inkl. størrelse, fx "75cl" — ikke separat felt v1)
|
||||
- vintage/årgang, pris (EUR)
|
||||
- is_organic (boolean — sat via checkbox, kilde: AB-mærket på
|
||||
producentens prisliste)
|
||||
|
||||
- **Order** — deltager + runde
|
||||
- payment_status (ubetalt/betalt), paid_at
|
||||
|
||||
- **OrderLine** — ordre + wine_offering + antal
|
||||
|
||||
## Mail-events
|
||||
1. Runde åbnes → mail til alle aktive deltagere på ruten
|
||||
2. Ordre afgivet → kvittering til deltager + notifikation til admin (findes allerede)
|
||||
3. **Nyt:** Admin markerer ordre "betalt" → automatisk kvitteringsmail til deltager
|
||||
SMTP: Postal (selvhostet)
|
||||
|
||||
## Fase 1 — nuværende scope
|
||||
1. Sæt FastAPI + SQLModel + PostgreSQL op med Alembic
|
||||
2. Definér modellerne ovenfor (inkl. Organization/Route-hierarki,
|
||||
selvom kun én organisation/rute findes i dag)
|
||||
3. Manuel dataindtastning: deltagere (og evt. en aktiv runde) fra MongoDB til PostgreSQL
|
||||
4. Simpelt login til User
|
||||
5. Admin CRUD: deltagere (inkl. aktiv/inaktiv — erstatter "tom bestilling"-tricket)
|
||||
6. Admin CRUD: runder + vinliste, med "kopiér fra forrige runde"
|
||||
(alle felter, inkl. kategori, forudfyldt og frit redigerbare)
|
||||
7. "Annoncér runde": skabelonmail til alle aktive deltagere på ruten
|
||||
8. Flyt offentlig bestillingsformular til nyt API (fortsat uden login)
|
||||
9. Admin-ordreoversigt pr. runde med "markér betalt" → trigger mail #3
|
||||
10. Genskab afhentningsliste (HTML-udtræk til print) mod ny datamodel
|
||||
11. Simpelt React admin-UI til pkt. 5, 6, 7, 9
|
||||
12. Testkør en rigtig runde gennem hele flowet
|
||||
|
||||
## Fase 2 — senere
|
||||
- enablebanking.com: automatisk match af indbetalinger mod ubetalte
|
||||
ordrer → kalder samme "markér betalt"-logik
|
||||
- Passkey-login til admin
|
||||
- Rute-vælger på bestillingssiden (når flere ruter er aktive samtidig)
|
||||
- sold_only_by_case-flag + validering, hvis det bliver relevant
|
||||
15
README.md
Normal file
15
README.md
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# Vinindkøb v2
|
||||
|
||||
Admin-backend til fælles vinindkøb (FastAPI + SQLModel + PostgreSQL +
|
||||
Alembic). Se [CLAUDE.md](CLAUDE.md) for projektplan og datamodel.
|
||||
|
||||
## Kom i gang
|
||||
|
||||
```
|
||||
uv sync
|
||||
cp .env.example .env # udfyld DATABASE_URL med din egen Postgres-instans
|
||||
uv run alembic upgrade head
|
||||
uv run fastapi dev app/main.py
|
||||
```
|
||||
|
||||
`GET /health` bekræfter at appen kan nå databasen.
|
||||
151
alembic.ini
Normal file
151
alembic.ini
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
# A generic, single database configuration.
|
||||
|
||||
[alembic]
|
||||
# path to migration scripts.
|
||||
# this is typically a path given in POSIX (e.g. forward slashes)
|
||||
# format, relative to the token %(here)s which refers to the location of this
|
||||
# ini file
|
||||
script_location = %(here)s/migrations
|
||||
|
||||
# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
|
||||
# Uncomment the line below if you want the files to be prepended with date and time
|
||||
# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
|
||||
# for all available tokens
|
||||
# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
|
||||
# Or organize into date-based subdirectories (requires recursive_version_locations = true)
|
||||
# file_template = %%(year)d/%%(month).2d/%%(day).2d_%%(hour).2d%%(minute).2d_%%(second).2d_%%(rev)s_%%(slug)s
|
||||
|
||||
# sys.path path, will be prepended to sys.path if present.
|
||||
# defaults to the current working directory. for multiple paths, the path separator
|
||||
# is defined by "path_separator" below.
|
||||
prepend_sys_path = .
|
||||
|
||||
|
||||
# timezone to use when rendering the date within the migration file
|
||||
# as well as the filename.
|
||||
# If specified, requires the tzdata library which can be installed by adding
|
||||
# `alembic[tz]` to the pip requirements.
|
||||
# string value is passed to ZoneInfo()
|
||||
# leave blank for localtime
|
||||
# timezone =
|
||||
|
||||
# max length of characters to apply to the "slug" field
|
||||
# truncate_slug_length = 40
|
||||
|
||||
# set to 'true' to run the environment during
|
||||
# the 'revision' command, regardless of autogenerate
|
||||
# revision_environment = false
|
||||
|
||||
# set to 'true' to allow .pyc and .pyo files without
|
||||
# a source .py file to be detected as revisions in the
|
||||
# versions/ directory
|
||||
# sourceless = false
|
||||
|
||||
# version location specification; This defaults
|
||||
# to <script_location>/versions. When using multiple version
|
||||
# directories, initial revisions must be specified with --version-path.
|
||||
# The path separator used here should be the separator specified by "path_separator"
|
||||
# below.
|
||||
# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions
|
||||
|
||||
# path_separator; This indicates what character is used to split lists of file
|
||||
# paths, including version_locations and prepend_sys_path within configparser
|
||||
# files such as alembic.ini.
|
||||
# The default rendered in new alembic.ini files is "os", which uses os.pathsep
|
||||
# to provide os-dependent path splitting.
|
||||
#
|
||||
# Note that in order to support legacy alembic.ini files, this default does NOT
|
||||
# take place if path_separator is not present in alembic.ini. If this
|
||||
# option is omitted entirely, fallback logic is as follows:
|
||||
#
|
||||
# 1. Parsing of the version_locations option falls back to using the legacy
|
||||
# "version_path_separator" key, which if absent then falls back to the legacy
|
||||
# behavior of splitting on spaces and/or commas.
|
||||
# 2. Parsing of the prepend_sys_path option falls back to the legacy
|
||||
# behavior of splitting on spaces, commas, or colons.
|
||||
#
|
||||
# Valid values for path_separator are:
|
||||
#
|
||||
# path_separator = :
|
||||
# path_separator = ;
|
||||
# path_separator = space
|
||||
# path_separator = newline
|
||||
#
|
||||
# Use os.pathsep. Default configuration used for new projects.
|
||||
path_separator = os
|
||||
|
||||
# set to 'true' to search source files recursively
|
||||
# in each "version_locations" directory
|
||||
# new in Alembic version 1.10
|
||||
# recursive_version_locations = false
|
||||
|
||||
# the output encoding used when revision files
|
||||
# are written from script.py.mako
|
||||
# output_encoding = utf-8
|
||||
|
||||
# database URL. This is consumed by the user-maintained env.py script only.
|
||||
# other means of configuring database URLs may be customized within the env.py
|
||||
# file.
|
||||
# Unused placeholder: env.py overrides this at runtime from app.core.config
|
||||
# (DATABASE_URL in .env), so the app and Alembic always share one source of truth.
|
||||
sqlalchemy.url = driver://user:pass@localhost/dbname
|
||||
|
||||
|
||||
[post_write_hooks]
|
||||
# post_write_hooks defines scripts or Python functions that are run
|
||||
# on newly generated revision scripts. See the documentation for further
|
||||
# detail and examples
|
||||
|
||||
# format using "black" - use the console_scripts runner, against the "black" entrypoint
|
||||
# hooks = black
|
||||
# black.type = console_scripts
|
||||
# black.entrypoint = black
|
||||
# black.options = -l 79 REVISION_SCRIPT_FILENAME
|
||||
|
||||
# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module
|
||||
# hooks = ruff
|
||||
# ruff.type = module
|
||||
# ruff.module = ruff
|
||||
# ruff.options = check --fix REVISION_SCRIPT_FILENAME
|
||||
|
||||
# Alternatively, use the exec runner to execute a binary found on your PATH
|
||||
# hooks = ruff
|
||||
# ruff.type = exec
|
||||
# ruff.executable = ruff
|
||||
# ruff.options = check --fix REVISION_SCRIPT_FILENAME
|
||||
|
||||
# Logging configuration. This is also consumed by the user-maintained
|
||||
# env.py script only.
|
||||
[loggers]
|
||||
keys = root,sqlalchemy,alembic
|
||||
|
||||
[handlers]
|
||||
keys = console
|
||||
|
||||
[formatters]
|
||||
keys = generic
|
||||
|
||||
[logger_root]
|
||||
level = WARNING
|
||||
handlers = console
|
||||
qualname =
|
||||
|
||||
[logger_sqlalchemy]
|
||||
level = WARNING
|
||||
handlers =
|
||||
qualname = sqlalchemy.engine
|
||||
|
||||
[logger_alembic]
|
||||
level = INFO
|
||||
handlers =
|
||||
qualname = alembic
|
||||
|
||||
[handler_console]
|
||||
class = StreamHandler
|
||||
args = (sys.stderr,)
|
||||
level = NOTSET
|
||||
formatter = generic
|
||||
|
||||
[formatter_generic]
|
||||
format = %(levelname)-5.5s [%(name)s] %(message)s
|
||||
datefmt = %H:%M:%S
|
||||
0
app/__init__.py
Normal file
0
app/__init__.py
Normal file
0
app/core/__init__.py
Normal file
0
app/core/__init__.py
Normal file
19
app/core/config.py
Normal file
19
app/core/config.py
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
from functools import lru_cache
|
||||
|
||||
from pydantic_settings import BaseSettings, SettingsConfigDict
|
||||
|
||||
|
||||
class Settings(BaseSettings):
|
||||
database_url: str
|
||||
environment: str = "development"
|
||||
|
||||
model_config = SettingsConfigDict(
|
||||
env_file=".env",
|
||||
env_file_encoding="utf-8",
|
||||
extra="ignore",
|
||||
)
|
||||
|
||||
|
||||
@lru_cache
|
||||
def get_settings() -> Settings:
|
||||
return Settings()
|
||||
23
app/db.py
Normal file
23
app/db.py
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
from collections.abc import Generator
|
||||
from typing import Annotated
|
||||
|
||||
from fastapi import Depends
|
||||
from sqlmodel import Session, create_engine
|
||||
|
||||
from app.core.config import get_settings
|
||||
|
||||
settings = get_settings()
|
||||
|
||||
engine = create_engine(
|
||||
settings.database_url,
|
||||
echo=settings.environment == "development",
|
||||
pool_pre_ping=True,
|
||||
)
|
||||
|
||||
|
||||
def get_session() -> Generator[Session, None, None]:
|
||||
with Session(engine) as session:
|
||||
yield session
|
||||
|
||||
|
||||
SessionDep = Annotated[Session, Depends(get_session)]
|
||||
12
app/main.py
Normal file
12
app/main.py
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
from fastapi import FastAPI
|
||||
from sqlalchemy import text
|
||||
|
||||
from app.db import SessionDep
|
||||
|
||||
app = FastAPI(title="Vinindkøb Admin API")
|
||||
|
||||
|
||||
@app.get("/health")
|
||||
def health(session: SessionDep) -> dict:
|
||||
session.exec(text("SELECT 1"))
|
||||
return {"status": "ok", "database": "ok"}
|
||||
9
app/models/__init__.py
Normal file
9
app/models/__init__.py
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
"""Import every model module so SQLModel.metadata is fully populated
|
||||
for Alembic autogenerate — new model files are picked up automatically,
|
||||
no manual registration needed here."""
|
||||
|
||||
from importlib import import_module
|
||||
from pkgutil import iter_modules
|
||||
|
||||
for _, module_name, _ in iter_modules(__path__):
|
||||
import_module(f"{__name__}.{module_name}")
|
||||
1
migrations/README
Normal file
1
migrations/README
Normal file
|
|
@ -0,0 +1 @@
|
|||
Generic single-database configuration.
|
||||
88
migrations/env.py
Normal file
88
migrations/env.py
Normal file
|
|
@ -0,0 +1,88 @@
|
|||
import os
|
||||
import sys
|
||||
from logging.config import fileConfig
|
||||
|
||||
from sqlalchemy import engine_from_config
|
||||
from sqlalchemy import pool
|
||||
from sqlmodel import SQLModel
|
||||
|
||||
from alembic import context
|
||||
|
||||
sys.path.append(os.getcwd()) # make `app` importable regardless of cwd
|
||||
|
||||
from app.core.config import get_settings # noqa: E402
|
||||
from app import models # noqa: E402,F401 -- populates SQLModel.metadata via auto-import
|
||||
|
||||
# this is the Alembic Config object, which provides
|
||||
# access to the values within the .ini file in use.
|
||||
config = context.config
|
||||
|
||||
# Share one source of truth for the DB URL with the FastAPI app instead of
|
||||
# whatever placeholder sits in alembic.ini.
|
||||
config.set_main_option("sqlalchemy.url", get_settings().database_url)
|
||||
|
||||
# Interpret the config file for Python logging.
|
||||
# This line sets up loggers basically.
|
||||
if config.config_file_name is not None:
|
||||
fileConfig(config.config_file_name)
|
||||
|
||||
# add your model's MetaData object here
|
||||
# for 'autogenerate' support
|
||||
target_metadata = SQLModel.metadata
|
||||
|
||||
# other values from the config, defined by the needs of env.py,
|
||||
# can be acquired:
|
||||
# my_important_option = config.get_main_option("my_important_option")
|
||||
# ... etc.
|
||||
|
||||
|
||||
def run_migrations_offline() -> None:
|
||||
"""Run migrations in 'offline' mode.
|
||||
|
||||
This configures the context with just a URL
|
||||
and not an Engine, though an Engine is acceptable
|
||||
here as well. By skipping the Engine creation
|
||||
we don't even need a DBAPI to be available.
|
||||
|
||||
Calls to context.execute() here emit the given string to the
|
||||
script output.
|
||||
|
||||
"""
|
||||
url = config.get_main_option("sqlalchemy.url")
|
||||
context.configure(
|
||||
url=url,
|
||||
target_metadata=target_metadata,
|
||||
literal_binds=True,
|
||||
dialect_opts={"paramstyle": "named"},
|
||||
)
|
||||
|
||||
with context.begin_transaction():
|
||||
context.run_migrations()
|
||||
|
||||
|
||||
def run_migrations_online() -> None:
|
||||
"""Run migrations in 'online' mode.
|
||||
|
||||
In this scenario we need to create an Engine
|
||||
and associate a connection with the context.
|
||||
|
||||
"""
|
||||
connectable = engine_from_config(
|
||||
config.get_section(config.config_ini_section, {}),
|
||||
prefix="sqlalchemy.",
|
||||
poolclass=pool.NullPool,
|
||||
)
|
||||
|
||||
with connectable.connect() as connection:
|
||||
context.configure(
|
||||
connection=connection, target_metadata=target_metadata
|
||||
)
|
||||
|
||||
with context.begin_transaction():
|
||||
context.run_migrations()
|
||||
|
||||
|
||||
if context.is_offline_mode():
|
||||
run_migrations_offline()
|
||||
else:
|
||||
run_migrations_online()
|
||||
28
migrations/script.py.mako
Normal file
28
migrations/script.py.mako
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
"""${message}
|
||||
|
||||
Revision ID: ${up_revision}
|
||||
Revises: ${down_revision | comma,n}
|
||||
Create Date: ${create_date}
|
||||
|
||||
"""
|
||||
from typing import Sequence, Union
|
||||
|
||||
from alembic import op
|
||||
import sqlalchemy as sa
|
||||
${imports if imports else ""}
|
||||
|
||||
# revision identifiers, used by Alembic.
|
||||
revision: str = ${repr(up_revision)}
|
||||
down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)}
|
||||
branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
|
||||
depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
|
||||
|
||||
|
||||
def upgrade() -> None:
|
||||
"""Upgrade schema."""
|
||||
${upgrades if upgrades else "pass"}
|
||||
|
||||
|
||||
def downgrade() -> None:
|
||||
"""Downgrade schema."""
|
||||
${downgrades if downgrades else "pass"}
|
||||
0
migrations/versions/.gitkeep
Normal file
0
migrations/versions/.gitkeep
Normal file
18
pyproject.toml
Normal file
18
pyproject.toml
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
[project]
|
||||
name = "vinindkoeb-v2"
|
||||
version = "0.1.0"
|
||||
description = "Add your description here"
|
||||
requires-python = ">=3.13"
|
||||
dependencies = [
|
||||
"alembic>=1.20.0",
|
||||
"fastapi[standard]>=0.141.1",
|
||||
"psycopg[binary]>=3.3.6",
|
||||
"pydantic-settings>=2.15.0",
|
||||
"sqlmodel>=0.0.47",
|
||||
]
|
||||
|
||||
[dependency-groups]
|
||||
dev = [
|
||||
"httpx>=0.28.1",
|
||||
"pytest>=9.1.1",
|
||||
]
|
||||
Loading…
Add table
Reference in a new issue