openschichtplaner5-api 1.1.0__py3-none-any.whl

openschichtplaner5_api-1.1.0.dist-info/METADATA

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: openschichtplaner5-api
+Version: 1.1.0
+Summary: REST API of OpenSchichtplaner5 — the FastAPI service layer over libopenschichtplaner5 (sp5lib): auth/2FA, employees, schedule, absences, reports, notifications and more.
+Author-email: Matthias Schabhüttl <matthias@matthiasschabhuettl.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/mschabhuettl/openschichtplaner5-api
+Project-URL: Source, https://github.com/mschabhuettl/openschichtplaner5-api
+Project-URL: Changelog, https://github.com/mschabhuettl/openschichtplaner5-api/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/mschabhuettl/openschichtplaner5-api/issues
+Project-URL: Main application, https://github.com/mschabhuettl/openschichtplaner5
+Project-URL: Core library, https://github.com/mschabhuettl/libopenschichtplaner5
+Keywords: schichtplaner5,shift-planning,fastapi,rest-api,scheduling
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Framework :: FastAPI
+Classifier: Topic :: Office/Business :: Scheduling
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi!=0.136.3,>=0.104.0
+Requires-Dist: uvicorn[standard]>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: starlette>=0.27.0
+Requires-Dist: anyio>=3.7.0
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: python-multipart>=0.0.7
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: slowapi>=0.1.9
+Requires-Dist: fpdf2>=2.7.0
+Requires-Dist: bcrypt>=4.0.0
+Requires-Dist: PyJWT>=2.8.0
+Requires-Dist: pyotp>=2.9.0
+Requires-Dist: qrcode[pil]>=7.4
+Requires-Dist: openpyxl>=3.1.0
+Requires-Dist: psutil>=5.9.0
+Requires-Dist: Pillow>=10.0.0
+Requires-Dist: SQLAlchemy>=2.0.0
+Requires-Dist: libopenschichtplaner5[postgres]>=1.6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# openschichtplaner5-api
+
+[![CI](https://github.com/mschabhuettl/openschichtplaner5-api/actions/workflows/ci.yml/badge.svg)](https://github.com/mschabhuettl/openschichtplaner5-api/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+The REST API behind [**OpenSchichtplaner5**](https://github.com/mschabhuettl/openschichtplaner5) —
+a pip-installable FastAPI service over
+[**libopenschichtplaner5**](https://github.com/mschabhuettl/libopenschichtplaner5) (`sp5lib`),
+serving shift-planning data from the original *Schichtplaner5* FoxPro `.DBF` files or the
+SQLite/PostgreSQL mirror: auth/2FA with JWT sessions, employees, schedule, absences,
+reports/exports, notifications (SSE), webhooks, iCal feeds and more.
+
+> **Import name:** the distribution is `openschichtplaner5-api`, but the importable
+> package is **`sp5api`** (mirroring `libopenschichtplaner5` → `sp5lib`).
+> It was extracted from the main app's `backend/api/` with full git history.
+
+## What's inside
+
+| Module | Purpose |
+|---|---|
+| `sp5api.main` | The FastAPI application (`sp5api.main:app`) — middlewares, health/metrics, SPA serving |
+| `sp5api.routers.*` | One router per domain: `auth`, `employees`, `schedule`, `absences`, `reports`, `notifications`, `availability`, `overtime`, `qualification_matrix`, `recurring_shifts`, `ical`, `webhooks`, `admin`, … |
+| `sp5api.dependencies` | Session store, JWT, rate limiting, logging, DB wiring |
+| `sp5api.schemas` / `sp5api.types` | Pydantic models / type aliases |
+| `sp5api.cache` / `sp5api.rate_limit_store` | Response caching, rate-limit event log |
+
+## Installation
+
+```bash
+pip install "openschichtplaner5-api @ git+https://github.com/mschabhuettl/openschichtplaner5-api.git@main"
+```
+
+(PyPI release pending — once published: `pip install openschichtplaner5-api`.)
+
+## Running
+
+```bash
+SP5_DB_PATH=/path/to/SP5/Daten python -m uvicorn sp5api.main:app --host 0.0.0.0 --port 8000
+```
+
+### Key environment variables
+
+| Variable | Default | Purpose |
+|---|---|---|
+| `SP5_DB_PATH` | *(set it!)* | Directory with the Schichtplaner5 `.DBF` files |
+| `SP5_BACKEND_DIR` | package parent dir | Host-app resource root: `<dir>/data`, `<dir>/api/data`, `<dir>/api/uploads`, alembic config. Shared contract with `sp5lib` — set it in installed deployments |
+| `SP5_FRONTEND_DIST` | `<SP5_BACKEND_DIR>/../frontend/dist` | Built SPA to serve at `/` (skipped if absent → API-only mode) |
+| `SP5_JWT_SECRET` / `SECRET_KEY` | random per process | JWT signing secret |
+| `SP5_DEV_MODE` | off | Dev bypass token — never in production |
+| `ALLOWED_ORIGINS` | localhost:5173/8000 | CORS origins (comma-separated) |
+| `DB_BACKEND` / `DATABASE_URL` | `dbf` | Switch to the PostgreSQL mirror (via `sp5lib`) |
+
+The full list (rate limits, brute-force lockout, SMTP, logging, password policy …) is
+documented in the main app's [`.env.example`](https://github.com/mschabhuettl/openschichtplaner5/blob/main/.env.example).
+
+## Development
+
+```bash
+python3 -m venv .venv && . .venv/bin/activate
+pip install -e ".[dev]"
+ruff check .
+pytest
+```
+
+To develop against a local clone of the library instead of the PyPI release:
+
+```bash
+pip install -e "../libopenschichtplaner5[postgres]"
+```
+
+`data/` and `api/data/` at the repo root are runtime-state seeds (skills, wishes,
+notification settings) used by the test suite — the same layout the main app keeps
+under `backend/`, resolved via `SP5_BACKEND_DIR`. `tests/fixtures/` holds the DBF
+fixture database.
+
+## Releasing
+
+Tag `vX.Y.Z` and push — the [release workflow](.github/workflows/release.yml) builds
+sdist+wheel and publishes to PyPI via Trusted Publishing (OIDC).
+
+## License
+
+MIT — see [LICENSE](LICENSE).

openschichtplaner5_api-1.1.0.dist-info/RECORD

@@ -0,0 +1,40 @@
+openschichtplaner5_api-1.1.0.dist-info/licenses/LICENSE,sha256=AR48Bxp-u4fRBkNgKZLE9NxZ30ENMrDgUVRTd4tPjUU,1077
+sp5api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sp5api/_paths.py,sha256=VcAtGM0U_gKb_mBAcOvynYlYGsktppMkXmJQYCj6XxA,929
+sp5api/cache.py,sha256=QPeO_irExgIzvyN0jv-cI4yxh1C8-xWtVaorQJM-gcY,2053
+sp5api/dependencies.py,sha256=E8u28rU21zVOorLVzgk4RWU5t2s98pRKDuhlXI-fSqE,17831
+sp5api/main.py,sha256=ko2Q4kOibzDDO2fDaeF5JrdA7O-_lFq6bS0uz_7HDSo,63125
+sp5api/rate_limit_store.py,sha256=vQzqsfISHUSbHn8t1Hoa7fSaJOPVoaXh1yqfCeu0mYM,3263
+sp5api/schemas.py,sha256=H5noGIbO1N8HHZQ-OEzOXvUHTGDoDoBtc_D7IYYJtb0,4150
+sp5api/types.py,sha256=jvG4QEW1G1I4az0g2lVlJp9eUQ6bZyP25aQg09QO1ww,505
+sp5api/routers/__init__.py,sha256=6Sb6gkmuQt6osPKmb5w5wq_jaaklrHeRmCkPSMh5LrQ,333
+sp5api/routers/absences.py,sha256=eREHFYA0NAYQRJp2sQbFUz3FC6qnJvDas--gRmFbfP4,32695
+sp5api/routers/admin.py,sha256=PprWukSBhsC8whPhHNxVu0mY1URgX8Ope0uYfiTbWCI,29507
+sp5api/routers/auth.py,sha256=Tj9cQwJvenNVVF734dIyeGuwqe2xH_AOX7Itv4T5WZg,25091
+sp5api/routers/availability.py,sha256=ivj1y6HuPYFvWLcCG01uD-p_TLfWcYsmXRImhsv6I8w,7687
+sp5api/routers/companies.py,sha256=0Jh5JqyEaoXj1eclBq2o6BIAtbLj_Xn2Hii0ZuPxeEU,8938
+sp5api/routers/conflict_report.py,sha256=lq473-1qMYb43ASC30b7AAizja564n30vbOA9R1qR-8,17653
+sp5api/routers/email.py,sha256=QRWnAfY-4vTVejRMfj7MdiuOBjjNtWZhYjLIIKoktvw,2284
+sp5api/routers/employees.py,sha256=7pjZ4TAiWd6Aop45MFKPurJXr4smX_BcNwcTV6zMxo8,35370
+sp5api/routers/events.py,sha256=kRGymZYO2IFrLciP47Uq41oWNNBbvCjKJAQSVto-qxY,3662
+sp5api/routers/export_scheduler.py,sha256=Mj5PVCBbKonjkOWsDeDosn5oE7agb6b73a4SBZqHtlo,19461
+sp5api/routers/ical.py,sha256=6p69sKJXL4eQ2Ed5eJq-Oz0dCO0ZAkmVkZkqR4VHKI8,22074
+sp5api/routers/master_data.py,sha256=llbC1TX5-ojsiWG68Ce4Bpbu_65CncvKruhkCMHAsN0,35816
+sp5api/routers/misc.py,sha256=aMveHT4Um7Xfw77w4d8wQQAUQ_dt7sO1rD5urPX4CsI,55376
+sp5api/routers/notification_settings.py,sha256=jWGQvRiniWzspkkAfKuYr1xgNh9Bd_9-_ABgdNdnjHc,2949
+sp5api/routers/notifications.py,sha256=pD7r4XVCWJmcUYMVvg-i9l-SsB7tMTC5PHUpUi71gQ0,10926
+sp5api/routers/orm_mirror.py,sha256=arBV7mBAegB7pTv_RZz6444lyhSIBaUFB0i-qQ6rOYQ,17213
+sp5api/routers/overtime.py,sha256=qXfsT_kJR6ljd6Sg11YwTco5KoGgTKbIEV4Zt3IoWW0,6428
+sp5api/routers/qualification_matrix.py,sha256=LPsyMdBPNMm7EQhtB6rDyrLpTHzgexbZq7f9ffTHFKk,4531
+sp5api/routers/recurring_shifts.py,sha256=U8ANaGVRv5cvwvwSDvR0oEMHbhPGrgkJz0GZLMIveI8,11390
+sp5api/routers/reports.py,sha256=2hRE3OKns3okQVJAy6JJVfMQ2HLaXejfJiZM8iHdDH4,153870
+sp5api/routers/schedule.py,sha256=gLsPRcXeiBscM03xwtXMsZxB1lXa9GiAsK_05EoOIyU,62615
+sp5api/routers/schedule_comments.py,sha256=10IhQDhES0nO9sKk1g2Fc-ADNqvylIhPHzW2uS3pRug,3171
+sp5api/routers/schedule_pdf.py,sha256=XMsWtWUAQXjynC7JNOezCuG4RFuIEMMMKvvhTPMTfPU,11102
+sp5api/routers/scheduled_reports.py,sha256=uAHd9SfoF6W_UbC7JyaYntNvmwv6XbVkoBI0BKbvvnk,32534
+sp5api/routers/webhooks.py,sha256=m40QdXq8xnMmTT6umtLk18jtYj3X-4tJEhsyneMJQEk,11274
+sp5api/routers/work_time_rules.py,sha256=vnCOEGQsp6d4JDvSWRRY5ddr6Z4NRKX5zn2vKWm-QF8,14606
+openschichtplaner5_api-1.1.0.dist-info/METADATA,sha256=7s7puacQp1FW-Foa-BHncDAPmk5Ge0782ro8vRFlQKc,6020
+openschichtplaner5_api-1.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+openschichtplaner5_api-1.1.0.dist-info/top_level.txt,sha256=CjMBVQStK8ckPWwfLuGmdUb73ezbcLbrkpkJrhR4Z2w,7
+openschichtplaner5_api-1.1.0.dist-info/RECORD,,

openschichtplaner5_api-1.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

openschichtplaner5_api-1.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Matthias Schabhüttl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

openschichtplaner5_api-1.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+sp5api

sp5api/_paths.py

@@ -0,0 +1,23 @@
+"""Resolve the host application's backend resource root.
+
+The API keeps mutable runtime state (JSON document stores, uploads) and finds
+host resources (frontend dist, CHANGELOG.md) under one root directory — the
+same root sp5lib (libopenschichtplaner5) resolves via the SP5_BACKEND_DIR
+environment variable: ``backend/`` in the main application, the repo root in
+this repository's dev/test checkout.
+
+The fallback mirrors ``sp5lib._resource_paths``: the directory containing the
+sp5api package. That is only correct for an in-tree/source checkout — installed
+deployments must set SP5_BACKEND_DIR explicitly (the main app's start.sh,
+Dockerfile and CI do).
+"""
+
+import os
+
+
+def backend_dir() -> str:
+    """Return the host backend root (see module docstring)."""
+    env = os.environ.get("SP5_BACKEND_DIR")
+    if env:
+        return os.path.abspath(env)
+    return os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

sp5api/cache.py

@@ -0,0 +1,75 @@
+"""Simple TTL-based in-memory cache for frequently queried DB data.
+
+No external dependencies (no Redis). Thread-safe via threading.Lock.
+Cache entries expire after TTL seconds and are invalidated on writes.
+"""
+
+import threading
+import time
+from typing import Any
+
+_lock = threading.Lock()
+_store: dict[str, tuple[float, Any]] = {}  # key -> (expires_at, value)
+
+# Default TTL in seconds
+DEFAULT_TTL = 60
+
+
+def get(key: str) -> Any | None:
+    """Return cached value if present and not expired, else None."""
+    with _lock:
+        entry = _store.get(key)
+        if entry is None:
+            return None
+        expires_at, value = entry
+        if time.monotonic() > expires_at:
+            del _store[key]
+            return None
+        return value
+
+
+def put(key: str, value: Any, ttl: float = DEFAULT_TTL) -> None:
+    """Store a value with the given TTL (seconds)."""
+    with _lock:
+        _store[key] = (time.monotonic() + ttl, value)
+
+
+def invalidate(*prefixes: str) -> int:
+    """Remove all cache entries whose keys start with any of the given prefixes.
+
+    Returns the number of entries removed.
+    """
+    with _lock:
+        to_delete = [
+            k for k in _store if any(k.startswith(p) for p in prefixes)
+        ]
+        for k in to_delete:
+            del _store[k]
+        return len(to_delete)
+
+
+def clear() -> int:
+    """Remove all entries. Returns count removed."""
+    with _lock:
+        n = len(_store)
+        _store.clear()
+        return n
+
+
+def stats() -> dict:
+    """Return cache statistics."""
+    with _lock:
+        now = time.monotonic()
+        total = len(_store)
+        expired = sum(1 for _, (exp, _v) in _store.items() if now > exp)
+        return {"total": total, "active": total - expired, "expired": expired}
+
+
+def get_or_set(key: str, factory, ttl: float = DEFAULT_TTL) -> Any:
+    """Return cached value or call factory() to compute, cache, and return it."""
+    value = get(key)
+    if value is not None:
+        return value
+    result = factory()
+    put(key, result, ttl)
+    return result