libopenschichtplaner5 1.1.0__tar.gz

libopenschichtplaner5-1.1.0/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.

libopenschichtplaner5-1.1.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: libopenschichtplaner5
+Version: 1.1.0
+Summary: Read and write the original Schichtplaner5 FoxPro .DBF database files, plus the SQLite/PostgreSQL ORM and sync layer used by OpenSchichtplaner5.
+Author-email: Matthias Schabhüttl <matthias@matthiasschabhuettl.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/mschabhuettl/libopenschichtplaner5
+Project-URL: Source, https://github.com/mschabhuettl/libopenschichtplaner5
+Project-URL: Changelog, https://github.com/mschabhuettl/libopenschichtplaner5/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/mschabhuettl/libopenschichtplaner5/issues
+Project-URL: Main application, https://github.com/mschabhuettl/openschichtplaner5
+Keywords: schichtplaner5,dbf,foxpro,shift-planning,dbase
+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.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Office/Business :: Scheduling
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: SQLAlchemy>=2.0.0
+Requires-Dist: alembic>=1.13.0
+Requires-Dist: bcrypt>=4.0.0
+Requires-Dist: pyotp>=2.9.0
+Requires-Dist: packaging>=21.0
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary>=2.9.0; extra == "postgres"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# libopenschichtplaner5
+
+[![CI](https://github.com/mschabhuettl/libopenschichtplaner5/actions/workflows/ci.yml/badge.svg)](https://github.com/mschabhuettl/libopenschichtplaner5/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+The core library behind [**OpenSchichtplaner5**](https://github.com/mschabhuettl/openschichtplaner5) —
+a pip-installable package that reads **and writes** the original *Schichtplaner5*
+FoxPro/dBASE `.DBF` database files, so an open replacement can run on the exact same
+data as the proprietary Windows tool, with no migration.
+
+> **Import name:** the distribution is `libopenschichtplaner5`, but the importable
+> package keeps its historical name **`sp5lib`** (like `pip install PyYAML` → `import yaml`).
+> This keeps OpenSchichtplaner5's imports unchanged after the extraction.
+
+## What's inside
+
+| Module | Purpose |
+|---|---|
+| `sp5lib.dbf_reader` | Pure-Python DBF reader (UTF-16-LE detection, date parsing, field decode) |
+| `sp5lib.dbf_writer` | Safe DBF writer — exclusive `flock`, TOCTOU-safe record count, rollback, EOF marker preservation |
+| `sp5lib.database` | High-level `SP5Database` facade over the DBF tables (employees, shifts, schedule, absences, auth, 2FA …) |
+| `sp5lib.db_factory` / `sqlite_adapter` / `pg_database` | Optional SQLite / PostgreSQL backends |
+| `sp5lib.orm` | SQLAlchemy models (`models.py` SQLite, `models_pg.py` Postgres), `repository`, `sync` |
+| `sp5lib.auto_migrate` | Alembic-based automatic migrations |
+| `sp5lib.email_service` | SMTP notification emails (HTML-escaped templates) |
+| `sp5lib.color_utils` | FoxPro BGR ↔ hex/RGB color helpers |
+
+## Installation
+
+```bash
+pip install "libopenschichtplaner5 @ git+https://github.com/mschabhuettl/libopenschichtplaner5.git"
+# with the optional PostgreSQL backend:
+pip install "libopenschichtplaner5[postgres] @ git+https://github.com/mschabhuettl/libopenschichtplaner5.git"
+```
+
+## Usage
+
+```python
+from sp5lib.database import SP5Database
+
+db = SP5Database("/path/to/SP5/Daten")        # directory of .DBF files
+for emp in db.get_employees():
+    print(emp["ID"], emp["NAME"], emp["FIRSTNAME"])
+```
+
+Low-level DBF access:
+
+```python
+from sp5lib.dbf_reader import read_dbf
+from sp5lib.dbf_writer import append_record, get_table_fields
+
+rows   = read_dbf("/path/to/SP5/Daten/5EMPL.DBF")
+fields = get_table_fields("/path/to/SP5/Daten/5EMPL.DBF")
+append_record("/path/to/SP5/Daten/5NOTE.DBF", fields, {"ID": 1, "TEXT": "hello"})
+```
+
+## Dependencies
+
+Runtime: `SQLAlchemy`, `alembic`, `bcrypt`, `pyotp`, `packaging`.
+Optional: `psycopg2-binary` (via the `postgres` extra) for the PostgreSQL backend.
+
+## Development
+
+```bash
+python -m venv .venv && . .venv/bin/activate
+pip install -e ".[dev,postgres]"
+pytest
+ruff check .
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE). Extracted (with full git history) from
+[OpenSchichtplaner5](https://github.com/mschabhuettl/openschichtplaner5)'s `backend/sp5lib/`.

libopenschichtplaner5-1.1.0/README.md

@@ -0,0 +1,74 @@
+# libopenschichtplaner5
+
+[![CI](https://github.com/mschabhuettl/libopenschichtplaner5/actions/workflows/ci.yml/badge.svg)](https://github.com/mschabhuettl/libopenschichtplaner5/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+The core library behind [**OpenSchichtplaner5**](https://github.com/mschabhuettl/openschichtplaner5) —
+a pip-installable package that reads **and writes** the original *Schichtplaner5*
+FoxPro/dBASE `.DBF` database files, so an open replacement can run on the exact same
+data as the proprietary Windows tool, with no migration.
+
+> **Import name:** the distribution is `libopenschichtplaner5`, but the importable
+> package keeps its historical name **`sp5lib`** (like `pip install PyYAML` → `import yaml`).
+> This keeps OpenSchichtplaner5's imports unchanged after the extraction.
+
+## What's inside
+
+| Module | Purpose |
+|---|---|
+| `sp5lib.dbf_reader` | Pure-Python DBF reader (UTF-16-LE detection, date parsing, field decode) |
+| `sp5lib.dbf_writer` | Safe DBF writer — exclusive `flock`, TOCTOU-safe record count, rollback, EOF marker preservation |
+| `sp5lib.database` | High-level `SP5Database` facade over the DBF tables (employees, shifts, schedule, absences, auth, 2FA …) |
+| `sp5lib.db_factory` / `sqlite_adapter` / `pg_database` | Optional SQLite / PostgreSQL backends |
+| `sp5lib.orm` | SQLAlchemy models (`models.py` SQLite, `models_pg.py` Postgres), `repository`, `sync` |
+| `sp5lib.auto_migrate` | Alembic-based automatic migrations |
+| `sp5lib.email_service` | SMTP notification emails (HTML-escaped templates) |
+| `sp5lib.color_utils` | FoxPro BGR ↔ hex/RGB color helpers |
+
+## Installation
+
+```bash
+pip install "libopenschichtplaner5 @ git+https://github.com/mschabhuettl/libopenschichtplaner5.git"
+# with the optional PostgreSQL backend:
+pip install "libopenschichtplaner5[postgres] @ git+https://github.com/mschabhuettl/libopenschichtplaner5.git"
+```
+
+## Usage
+
+```python
+from sp5lib.database import SP5Database
+
+db = SP5Database("/path/to/SP5/Daten")        # directory of .DBF files
+for emp in db.get_employees():
+    print(emp["ID"], emp["NAME"], emp["FIRSTNAME"])
+```
+
+Low-level DBF access:
+
+```python
+from sp5lib.dbf_reader import read_dbf
+from sp5lib.dbf_writer import append_record, get_table_fields
+
+rows   = read_dbf("/path/to/SP5/Daten/5EMPL.DBF")
+fields = get_table_fields("/path/to/SP5/Daten/5EMPL.DBF")
+append_record("/path/to/SP5/Daten/5NOTE.DBF", fields, {"ID": 1, "TEXT": "hello"})
+```
+
+## Dependencies
+
+Runtime: `SQLAlchemy`, `alembic`, `bcrypt`, `pyotp`, `packaging`.
+Optional: `psycopg2-binary` (via the `postgres` extra) for the PostgreSQL backend.
+
+## Development
+
+```bash
+python -m venv .venv && . .venv/bin/activate
+pip install -e ".[dev,postgres]"
+pytest
+ruff check .
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE). Extracted (with full git history) from
+[OpenSchichtplaner5](https://github.com/mschabhuettl/openschichtplaner5)'s `backend/sp5lib/`.

libopenschichtplaner5-1.1.0/libopenschichtplaner5.egg-info/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: libopenschichtplaner5
+Version: 1.1.0
+Summary: Read and write the original Schichtplaner5 FoxPro .DBF database files, plus the SQLite/PostgreSQL ORM and sync layer used by OpenSchichtplaner5.
+Author-email: Matthias Schabhüttl <matthias@matthiasschabhuettl.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/mschabhuettl/libopenschichtplaner5
+Project-URL: Source, https://github.com/mschabhuettl/libopenschichtplaner5
+Project-URL: Changelog, https://github.com/mschabhuettl/libopenschichtplaner5/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/mschabhuettl/libopenschichtplaner5/issues
+Project-URL: Main application, https://github.com/mschabhuettl/openschichtplaner5
+Keywords: schichtplaner5,dbf,foxpro,shift-planning,dbase
+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.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Office/Business :: Scheduling
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: SQLAlchemy>=2.0.0
+Requires-Dist: alembic>=1.13.0
+Requires-Dist: bcrypt>=4.0.0
+Requires-Dist: pyotp>=2.9.0
+Requires-Dist: packaging>=21.0
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary>=2.9.0; extra == "postgres"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# libopenschichtplaner5
+
+[![CI](https://github.com/mschabhuettl/libopenschichtplaner5/actions/workflows/ci.yml/badge.svg)](https://github.com/mschabhuettl/libopenschichtplaner5/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+The core library behind [**OpenSchichtplaner5**](https://github.com/mschabhuettl/openschichtplaner5) —
+a pip-installable package that reads **and writes** the original *Schichtplaner5*
+FoxPro/dBASE `.DBF` database files, so an open replacement can run on the exact same
+data as the proprietary Windows tool, with no migration.
+
+> **Import name:** the distribution is `libopenschichtplaner5`, but the importable
+> package keeps its historical name **`sp5lib`** (like `pip install PyYAML` → `import yaml`).
+> This keeps OpenSchichtplaner5's imports unchanged after the extraction.
+
+## What's inside
+
+| Module | Purpose |
+|---|---|
+| `sp5lib.dbf_reader` | Pure-Python DBF reader (UTF-16-LE detection, date parsing, field decode) |
+| `sp5lib.dbf_writer` | Safe DBF writer — exclusive `flock`, TOCTOU-safe record count, rollback, EOF marker preservation |
+| `sp5lib.database` | High-level `SP5Database` facade over the DBF tables (employees, shifts, schedule, absences, auth, 2FA …) |
+| `sp5lib.db_factory` / `sqlite_adapter` / `pg_database` | Optional SQLite / PostgreSQL backends |
+| `sp5lib.orm` | SQLAlchemy models (`models.py` SQLite, `models_pg.py` Postgres), `repository`, `sync` |
+| `sp5lib.auto_migrate` | Alembic-based automatic migrations |
+| `sp5lib.email_service` | SMTP notification emails (HTML-escaped templates) |
+| `sp5lib.color_utils` | FoxPro BGR ↔ hex/RGB color helpers |
+
+## Installation
+
+```bash
+pip install "libopenschichtplaner5 @ git+https://github.com/mschabhuettl/libopenschichtplaner5.git"
+# with the optional PostgreSQL backend:
+pip install "libopenschichtplaner5[postgres] @ git+https://github.com/mschabhuettl/libopenschichtplaner5.git"
+```
+
+## Usage
+
+```python
+from sp5lib.database import SP5Database
+
+db = SP5Database("/path/to/SP5/Daten")        # directory of .DBF files
+for emp in db.get_employees():
+    print(emp["ID"], emp["NAME"], emp["FIRSTNAME"])
+```
+
+Low-level DBF access:
+
+```python
+from sp5lib.dbf_reader import read_dbf
+from sp5lib.dbf_writer import append_record, get_table_fields
+
+rows   = read_dbf("/path/to/SP5/Daten/5EMPL.DBF")
+fields = get_table_fields("/path/to/SP5/Daten/5EMPL.DBF")
+append_record("/path/to/SP5/Daten/5NOTE.DBF", fields, {"ID": 1, "TEXT": "hello"})
+```
+
+## Dependencies
+
+Runtime: `SQLAlchemy`, `alembic`, `bcrypt`, `pyotp`, `packaging`.
+Optional: `psycopg2-binary` (via the `postgres` extra) for the PostgreSQL backend.
+
+## Development
+
+```bash
+python -m venv .venv && . .venv/bin/activate
+pip install -e ".[dev,postgres]"
+pytest
+ruff check .
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE). Extracted (with full git history) from
+[OpenSchichtplaner5](https://github.com/mschabhuettl/openschichtplaner5)'s `backend/sp5lib/`.

libopenschichtplaner5-1.1.0/libopenschichtplaner5.egg-info/SOURCES.txt

@@ -0,0 +1,28 @@
+LICENSE
+README.md
+pyproject.toml
+libopenschichtplaner5.egg-info/PKG-INFO
+libopenschichtplaner5.egg-info/SOURCES.txt
+libopenschichtplaner5.egg-info/dependency_links.txt
+libopenschichtplaner5.egg-info/requires.txt
+libopenschichtplaner5.egg-info/top_level.txt
+sp5lib/__init__.py
+sp5lib/_resource_paths.py
+sp5lib/auto_migrate.py
+sp5lib/color_utils.py
+sp5lib/database.py
+sp5lib/db_config.py
+sp5lib/db_factory.py
+sp5lib/dbf_reader.py
+sp5lib/dbf_writer.py
+sp5lib/email_service.py
+sp5lib/pg_database.py
+sp5lib/py.typed
+sp5lib/sqlite_adapter.py
+sp5lib/orm/__init__.py
+sp5lib/orm/base.py
+sp5lib/orm/models.py
+sp5lib/orm/models_pg.py
+sp5lib/orm/repository.py
+sp5lib/orm/sync.py
+tests/test_dbf.py

libopenschichtplaner5-1.1.0/libopenschichtplaner5.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

libopenschichtplaner5-1.1.0/libopenschichtplaner5.egg-info/requires.txt

@@ -0,0 +1,13 @@
+SQLAlchemy>=2.0.0
+alembic>=1.13.0
+bcrypt>=4.0.0
+pyotp>=2.9.0
+packaging>=21.0
+
+[dev]
+pytest>=7.4.0
+pytest-cov>=4.1.0
+ruff>=0.1.0
+
+[postgres]
+psycopg2-binary>=2.9.0

libopenschichtplaner5-1.1.0/libopenschichtplaner5.egg-info/top_level.txt

@@ -0,0 +1 @@
+sp5lib

libopenschichtplaner5-1.1.0/pyproject.toml

@@ -0,0 +1,71 @@
+[build-system]
+requires = ["setuptools>=77.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "libopenschichtplaner5"
+version = "1.1.0"
+description = "Read and write the original Schichtplaner5 FoxPro .DBF database files, plus the SQLite/PostgreSQL ORM and sync layer used by OpenSchichtplaner5."
+readme = { file = "README.md", content-type = "text/markdown" }
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Matthias Schabhüttl", email = "matthias@matthiasschabhuettl.com" }]
+requires-python = ">=3.10"
+keywords = ["schichtplaner5", "dbf", "foxpro", "shift-planning", "dbase"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Database",
+    "Topic :: Office/Business :: Scheduling",
+    "Typing :: Typed",
+]
+dependencies = [
+    "SQLAlchemy>=2.0.0",
+    "alembic>=1.13.0",
+    "bcrypt>=4.0.0",
+    "pyotp>=2.9.0",
+    "packaging>=21.0",
+]
+
+[project.optional-dependencies]
+postgres = ["psycopg2-binary>=2.9.0"]
+dev = [
+    "pytest>=7.4.0",
+    "pytest-cov>=4.1.0",
+    "ruff>=0.1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/mschabhuettl/libopenschichtplaner5"
+Source = "https://github.com/mschabhuettl/libopenschichtplaner5"
+Changelog = "https://github.com/mschabhuettl/libopenschichtplaner5/blob/main/CHANGELOG.md"
+Issues = "https://github.com/mschabhuettl/libopenschichtplaner5/issues"
+"Main application" = "https://github.com/mschabhuettl/openschichtplaner5"
+
+[tool.setuptools]
+packages = ["sp5lib", "sp5lib.orm"]
+
+[tool.setuptools.package-data]
+sp5lib = ["py.typed"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "B", "UP"]
+ignore = [
+    "E501",  # line too long (handled by formatter)
+    "E712",  # == False / == True — required for SQLAlchemy WHERE clauses
+    "B008",  # function calls in default arguments
+    "B904",  # raise-without-from-inside-except — inherited, fix incrementally
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

libopenschichtplaner5-1.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

libopenschichtplaner5-1.1.0/sp5lib/__init__.py

@@ -0,0 +1 @@
+# OpenSchichtplaner5 - Python library for reading Schichtplaner5 databases

libopenschichtplaner5-1.1.0/sp5lib/_resource_paths.py

@@ -0,0 +1,40 @@
+"""Resolution of host-application resource directories.
+
+Historically these modules lived inside the OpenSchichtplaner5 ``backend/`` tree and
+located sibling resources (``backend/data``, ``backend/api/data``, the Alembic
+directory) via paths relative to ``__file__``. Once this library is installed as a
+standalone package (``libopenschichtplaner5``) that assumption no longer holds — the
+package lives in ``site-packages`` and the host app's data lives elsewhere.
+
+The host application therefore tells the library where its backend root is via the
+``SP5_BACKEND_DIR`` environment variable. When unset, we fall back to the legacy
+``<this_package_parent>`` location so an in-tree checkout keeps working unchanged.
+"""
+
+from __future__ import annotations
+
+import os
+
+
+def backend_dir() -> str:
+    """Return the host application's backend root directory.
+
+    Honors ``SP5_BACKEND_DIR``; otherwise falls back to the directory that contains
+    this package (the legacy in-tree layout ``<backend>/sp5lib/``).
+    """
+    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__)))
+
+
+def data_dir() -> str:
+    """``<backend>/data`` — JSON-backed settings (changelog, swaps, comments …)."""
+    path = os.path.join(backend_dir(), "data")
+    os.makedirs(path, exist_ok=True)
+    return path
+
+
+def api_data_dir() -> str:
+    """``<backend>/api/data`` — availability / skills JSON written by the API layer."""
+    return os.path.join(backend_dir(), "api", "data")