Python-code moved to backend/ directory.

This commit is contained in:
Frank Agerholm 2026-01-25 10:37:57 +01:00
commit f048b0be58
No known key found for this signature in database
15 changed files with 0 additions and 0 deletions

2
backend/.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
.env
__pycache__

13
backend/INSTALL.md Normal file
View file

@ -0,0 +1,13 @@
# Umgebung einrichten
```
poetry install
```
# Dev-Server starten
```
poetry run uviron app.main:app --reload
```

149
backend/alembic.ini Normal file
View file

@ -0,0 +1,149 @@
# 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.
sqlalchemy.url = "postgresql+psycopg://server_worklog:JKsXLUPDCUnLCoGScxv2sYNF@localhost:5432/server_worklog"
[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

66
backend/app/auth.py Normal file
View file

@ -0,0 +1,66 @@
from datetime import datetime, timedelta
from typing import Optional
from fastapi import Depends, HTTPException, status
from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
from jose import jwt, JWTError
from passlib.context import CryptContext
from sqlalchemy.orm import Session
from .db import SessionLocal
from . import models
from .config import settings
SECRET_KEY = settings.secret_key
ALGORITHM = "HS256"
ACCESS_TOKEN_EXPIRE_MINUTES = 60
pwd_context = CryptContext(schemes=["bcrypt_sha256"], deprecated="auto")
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/auth/token")
def get_db():
db = SessionLocal()
try:
yield db
finally:
db.close()
def verify_password(plain_password, hashed_password):
return pwd_context.verify(plain_password, hashed_password)
def get_password_hash(password):
return pwd_context.hash(password)
def authenticate_user(db: Session, username: str, password: str) -> Optional[models.User]:
user = db.query(models.User).filter(models.User.username == username).first()
if not user or not verify_password(password, user.password_hash):
return None
return user
def create_access_token(data: dict, expires_delta: Optional[timedelta] = None):
to_encode = data.copy()
expire = datetime.utcnow() + (expires_delta or timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES))
to_encode.update({"exp": expire})
return jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
async def get_current_user(
token: str = Depends(oauth2_scheme),
db: Session = Depends(get_db),
) -> models.User:
credentials_exception = HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Could not validate credentials",
headers={"WWW-Authenticate": "Bearer"},
)
try:
payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
username: str | None = payload.get("preferred_username") or payload.get("sub")
if username is None:
raise credentials_exception
except JWTError:
raise credentials_exception
user = db.query(models.User).filter(models.User.username == username).first()
if user is None:
raise credentials_exception
return user

25
backend/app/config.py Normal file
View file

@ -0,0 +1,25 @@
from pydantic import BaseModel
from dotenv import load_dotenv
import os
# .env laden
load_dotenv()
class Settings(BaseModel):
db_host: str = os.getenv("DB_HOST", "localhost")
db_port: int = int(os.getenv("DB_PORT", "5432"))
db_name: str = os.getenv("DB_NAME", "server_worklog")
db_user: str = os.getenv("DB_USER", "postgres")
db_password: str = os.getenv("DB_PASSWORD", "postgres")
secret_key: str = os.getenv("SECRET_KEY", "CHANGE_ME")
@property
def database_url(self):
return (
f"postgresql+psycopg://{self.db_user}:{self.db_password}"
f"@{self.db_host}:{self.db_port}/{self.db_name}"
)
settings = Settings()

9
backend/app/db.py Normal file
View file

@ -0,0 +1,9 @@
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker, DeclarativeBase
from app.config import settings
engine = create_engine(settings.database_url, future=True)
SessionLocal = sessionmaker(bind=engine, autoflush=False, autocommit=False)
class Base(DeclarativeBase):
pass

155
backend/app/main.py Normal file
View file

@ -0,0 +1,155 @@
from fastapi import FastAPI, Depends, HTTPException, status
from sqlalchemy.orm import Session
from typing import List
from fastapi import Query
from .db import Base, engine
from . import models, schemas
from .auth import (
get_db, get_current_user, authenticate_user,
create_access_token, get_password_hash,
)
from fastapi.security import OAuth2PasswordRequestForm
app = FastAPI(title="Server Worklog")
# Nur für lokale Entwicklung, in Produktion via Alembic
Base.metadata.create_all(bind=engine)
@app.post("/auth/register", response_model=schemas.UserRead)
def register_user(user_in: schemas.UserCreate, db: Session = Depends(get_db)):
existing = db.query(models.User).filter(models.User.username == user_in.username).first()
if existing:
raise HTTPException(status_code=400, detail="Username already registered")
user = models.User(
username=user_in.username,
password_hash=get_password_hash(user_in.password),
)
db.add(user)
db.commit()
db.refresh(user)
return user
@app.post("/auth/token")
def login_for_access_token(
form_data: OAuth2PasswordRequestForm = Depends(),
db: Session = Depends(get_db),
):
user = authenticate_user(db, form_data.username, form_data.password)
if not user:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Incorrect username or password",
)
# OIDC-ähnliche Claims
access_token = create_access_token(
data={
"sub": str(user.id),
"preferred_username": user.username,
}
)
return {"access_token": access_token, "token_type": "bearer"}
# Owner CRUD
@app.post("/owners", response_model=schemas.OwnerRead)
def create_owner(
owner_in: schemas.OwnerCreate,
db: Session = Depends(get_db),
user=Depends(get_current_user),
):
owner = models.Owner(**owner_in.model_dump())
db.add(owner)
db.commit()
db.refresh(owner)
return owner
@app.get("/owners", response_model=List[schemas.OwnerRead])
def list_owners(
db: Session = Depends(get_db),
user=Depends(get_current_user),
):
return db.query(models.Owner).all()
# Server CRUD
@app.post("/servers", response_model=schemas.ServerRead)
def create_server(
server_in: schemas.ServerCreate,
db: Session = Depends(get_db),
user=Depends(get_current_user),
):
server = models.Server(**server_in.model_dump())
db.add(server)
db.commit()
db.refresh(server)
return server
@app.get("/servers", response_model=List[schemas.ServerRead])
def list_servers(
db: Session = Depends(get_db),
user=Depends(get_current_user),
):
return db.query(models.Server).all()
# WorkEntries
@app.post("/work-entries", response_model=schemas.WorkEntryRead)
def create_work_entry(
entry_in: schemas.WorkEntryCreate,
db: Session = Depends(get_db),
user=Depends(get_current_user),
):
servers = db.query(models.Server).filter(
models.Server.id.in_(entry_in.server_ids)
).all()
if len(servers) != len(entry_in.server_ids):
raise HTTPException(status_code=400, detail="One or more servers not found")
entry = models.WorkEntry(
title=entry_in.title,
description=entry_in.description,
duration_minutes=entry_in.duration_minutes,
created_by_user_id=user.id,
servers=servers,
)
db.add(entry)
db.commit()
db.refresh(entry)
return entry
@app.get("/work-entries", response_model=List[schemas.WorkEntryRead])
def search_work_entries(
q: str | None = Query(default=None, description="Freitextsuche in Titel/Beschreibung"),
server_id: int | None = None,
db: Session = Depends(get_db),
user=Depends(get_current_user),
):
query = db.query(models.WorkEntry)
if q:
like = f"%{q}%"
query = query.filter(
(models.WorkEntry.title.ilike(like)) |
(models.WorkEntry.description.ilike(like))
)
if server_id:
query = query.join(models.WorkEntry.servers).filter(models.Server.id == server_id)
query = query.order_by(models.WorkEntry.created_at.desc())
return query.all()
@app.get("/servers/{server_id}/work-entries", response_model=List[schemas.WorkEntryRead])
def list_work_entries_for_server(
server_id: int,
db: Session = Depends(get_db),
user=Depends(get_current_user),
):
entries = (
db.query(models.WorkEntry)
.join(models.WorkEntry.servers)
.filter(models.Server.id == server_id)
.order_by(models.WorkEntry.created_at.asc())
.all()
)
return entries

63
backend/app/models.py Normal file
View file

@ -0,0 +1,63 @@
from sqlalchemy import (
Column, Integer, String, Text, ForeignKey, DateTime, Table
)
from sqlalchemy.orm import relationship, Mapped, mapped_column
from datetime import datetime
from .db import Base
work_entry_servers = Table(
"work_entry_servers",
Base.metadata,
Column("work_entry_id", ForeignKey("work_entries.id"), primary_key=True),
Column("server_id", ForeignKey("servers.id"), primary_key=True),
)
class User(Base):
__tablename__ = "users"
id: Mapped[int] = mapped_column(primary_key=True, index=True)
username: Mapped[str] = mapped_column(String(50), unique=True, index=True)
password_hash: Mapped[str] = mapped_column(String(255))
is_active: Mapped[bool] = mapped_column(default=True)
class Owner(Base):
__tablename__ = "owners"
id: Mapped[int] = mapped_column(primary_key=True)
name: Mapped[str] = mapped_column(String(100), unique=True)
contact: Mapped[str | None] = mapped_column(String(255), nullable=True)
servers: Mapped[list["Server"]] = relationship("Server", back_populates="owner")
class Server(Base):
__tablename__ = "servers"
id: Mapped[int] = mapped_column(primary_key=True)
hostname: Mapped[str] = mapped_column(String(100), unique=True, index=True)
description: Mapped[str | None] = mapped_column(Text, nullable=True)
owner_id: Mapped[int | None] = mapped_column(ForeignKey("owners.id"))
owner: Mapped[Owner | None] = relationship("Owner", back_populates="servers")
work_entries: Mapped[list["WorkEntry"]] = relationship(
"WorkEntry",
secondary=work_entry_servers,
back_populates="servers",
)
class WorkEntry(Base):
__tablename__ = "work_entries"
id: Mapped[int] = mapped_column(primary_key=True)
title: Mapped[str] = mapped_column(String(200))
description: Mapped[str | None] = mapped_column(Text, nullable=True)
created_at: Mapped[datetime] = mapped_column(default=datetime.utcnow)
duration_minutes: Mapped[int | None] = mapped_column(nullable=True)
created_by_user_id: Mapped[int] = mapped_column(ForeignKey("users.id"))
servers: Mapped[list[Server]] = relationship(
"Server",
secondary=work_entry_servers,
back_populates="work_entries",
)

56
backend/app/schemas.py Normal file
View file

@ -0,0 +1,56 @@
from datetime import datetime
from pydantic import BaseModel
class OwnerBase(BaseModel):
name: str
contact: str | None = None
class OwnerCreate(OwnerBase):
pass
class OwnerRead(OwnerBase):
id: int
class Config:
from_attributes = True
class ServerBase(BaseModel):
hostname: str
description: str | None = None
owner_id: int | None = None
class ServerCreate(ServerBase):
pass
class ServerRead(ServerBase):
id: int
owner: OwnerRead | None = None
class Config:
from_attributes = True
class WorkEntryBase(BaseModel):
title: str
description: str | None = None
duration_minutes: int | None = None
class WorkEntryCreate(WorkEntryBase):
server_ids: list[int] | None = None
pass
class WorkEntryRead(WorkEntryBase):
id: int
created_at: datetime
created_by_user_id: int
servers: list[ServerRead]
class Config:
from_attributes = True
class UserCreate(BaseModel):
username: str
password: str
class UserRead(BaseModel):
id: int
username: str
class Config:
from_attributes = True

View file

@ -0,0 +1 @@
Generic single-database configuration.

83
backend/migrations/env.py Normal file
View file

@ -0,0 +1,83 @@
from logging.config import fileConfig
from sqlalchemy import engine_from_config
from sqlalchemy import pool
from alembic import context
from app.config import settings
from app.db import Base
from app import models # noqa: F401
# this is the Alembic Config object, which provides
# access to the values within the .ini file in use.
config = context.config
config.set_main_option("sqlalchemy.url", 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
# from myapp import mymodel
# target_metadata = mymodel.Base.metadata
target_metadata = Base.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()

View 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"}

View file

@ -0,0 +1,80 @@
"""initial schema
Revision ID: b552ac5a278a
Revises:
Create Date: 2026-01-25 09:13:19.361950
"""
from typing import Sequence, Union
from alembic import op
import sqlalchemy as sa
# revision identifiers, used by Alembic.
revision: str = 'b552ac5a278a'
down_revision: Union[str, Sequence[str], None] = None
branch_labels: Union[str, Sequence[str], None] = None
depends_on: Union[str, Sequence[str], None] = None
def upgrade() -> None:
"""Upgrade schema."""
# ### commands auto generated by Alembic - please adjust! ###
op.create_table('owners',
sa.Column('id', sa.Integer(), nullable=False),
sa.Column('name', sa.String(length=100), nullable=False),
sa.Column('contact', sa.String(length=255), nullable=True),
sa.PrimaryKeyConstraint('id'),
sa.UniqueConstraint('name')
)
op.create_table('users',
sa.Column('id', sa.Integer(), nullable=False),
sa.Column('username', sa.String(length=50), nullable=False),
sa.Column('password_hash', sa.String(length=255), nullable=False),
sa.Column('is_active', sa.Boolean(), nullable=False),
sa.PrimaryKeyConstraint('id')
)
op.create_index(op.f('ix_users_id'), 'users', ['id'], unique=False)
op.create_index(op.f('ix_users_username'), 'users', ['username'], unique=True)
op.create_table('servers',
sa.Column('id', sa.Integer(), nullable=False),
sa.Column('hostname', sa.String(length=100), nullable=False),
sa.Column('description', sa.Text(), nullable=True),
sa.Column('owner_id', sa.Integer(), nullable=True),
sa.ForeignKeyConstraint(['owner_id'], ['owners.id'], ),
sa.PrimaryKeyConstraint('id')
)
op.create_index(op.f('ix_servers_hostname'), 'servers', ['hostname'], unique=True)
op.create_table('work_entries',
sa.Column('id', sa.Integer(), nullable=False),
sa.Column('title', sa.String(length=200), nullable=False),
sa.Column('description', sa.Text(), nullable=True),
sa.Column('created_at', sa.DateTime(), nullable=False),
sa.Column('duration_minutes', sa.Integer(), nullable=True),
sa.Column('created_by_user_id', sa.Integer(), nullable=False),
sa.ForeignKeyConstraint(['created_by_user_id'], ['users.id'], ),
sa.PrimaryKeyConstraint('id')
)
op.create_table('work_entry_servers',
sa.Column('work_entry_id', sa.Integer(), nullable=False),
sa.Column('server_id', sa.Integer(), nullable=False),
sa.ForeignKeyConstraint(['server_id'], ['servers.id'], ),
sa.ForeignKeyConstraint(['work_entry_id'], ['work_entries.id'], ),
sa.PrimaryKeyConstraint('work_entry_id', 'server_id')
)
# ### end Alembic commands ###
def downgrade() -> None:
"""Downgrade schema."""
# ### commands auto generated by Alembic - please adjust! ###
op.drop_table('work_entry_servers')
op.drop_table('work_entries')
op.drop_index(op.f('ix_servers_hostname'), table_name='servers')
op.drop_table('servers')
op.drop_index(op.f('ix_users_username'), table_name='users')
op.drop_index(op.f('ix_users_id'), table_name='users')
op.drop_table('users')
op.drop_table('owners')
# ### end Alembic commands ###

1507
backend/poetry.lock generated Normal file

File diff suppressed because it is too large Load diff

25
backend/pyproject.toml Normal file
View file

@ -0,0 +1,25 @@
[tool.poetry]
name = "server-worklog"
version = "0.1.0"
description = "Kleine Webanwendung zum Protokollieren von Arbeiten an Servern"
authors = ["Frank Agerholm <frank@agerholm.de>"]
package-mode = false
[tool.poetry.dependencies]
python = "^3.12"
fastapi = "^0.115.0"
uvicorn = {extras = ["standard"], version = "^0.30.0"}
SQLAlchemy = "^2.0.0"
psycopg = {version = "^3.1.0", extras = ["binary"]}
alembic = "^1.13.0"
python-jose = "^3.3.0"
passlib = {version = "^1.7.4", extras = ["bcrypt"]}
pydantic = "^2.0.0"
python-dotenv = "^1.2.1"
python-multipart = "^0.0.21"
bcrypt = "<4.0.0"
[tool.poetry.group.dev.dependencies]
pytest = "^8.0.0"
httpx = "^0.27.0"