deped-dcp-template 0.1.0__tar.gz

deped_dcp_template-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: Example UV CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  uv-example:
+    name: Python (UV)
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@main
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install the project with UV
+        run: uv sync --locked --all-extras --dev
+
+      - name: Install Dependencies
+        run: |
+          uv tool install pre-commit --with pre-commit-uv
+          pre-commit install-hooks
+
+      - name: Lint with pre-commit
+        run: pre-commit run --all-files
+
+      - name: Run tests
+        run: uv run pytest

deped_dcp_template-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.venv/
+.pytest_cache/
+.ruff_cache/
+__pycache__/
+*.py[cod]
+.coverage
+.env
+dist/

deped_dcp_template-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+default_language_version:
+  python: python3.14
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: name-tests-test
+        args: ["--django"]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.15.8
+    hooks:
+      # Run the linter.
+      - id: ruff-check
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format
+        types_or: [ python, pyi, jupyter ]

deped_dcp_template-0.1.0/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: deped-dcp-template
+Version: 0.1.0
+Summary: Shared runtime helpers for DepEd DCP data-cleaning packages.
+Requires-Python: >=3.14
+Requires-Dist: email-validator>=2.3.0
+Requires-Dist: rich>=14.3.3
+Description-Content-Type: text/markdown
+
+# deped-dcp-template
+
+`deped-dcp-template` is a shared runtime library for the DepEd DCP package set.
+
+It owns reusable Python helpers that were previously duplicated across
+`deped-personnel`, `deped-equipment`, and `deped-connectivity`, including:
+
+- text, identifier, date, phone, email, and position normalization
+- CSV row iteration and progress helpers
+- common governance entity helpers
+- shared personnel-loader utility functions
+- canonical constant tables and lookup-extension hooks
+
+This package does not own SQL schemas, workbook extraction, or SQLite artifact
+contracts. Those remain package-local in `deped-asset`.
+
+## Install
+
+Published dependency:
+
+```bash
+uv add deped-dcp-template
+```
+
+Local development against a sibling checkout:
+
+```toml
+[tool.uv.sources]
+deped-dcp-template = { path = "../deped-dcp-template" }
+```
+
+## Tests
+
+```bash
+uv run pytest -q
+```

deped_dcp_template-0.1.0/README.md

@@ -0,0 +1,36 @@
+# deped-dcp-template
+
+`deped-dcp-template` is a shared runtime library for the DepEd DCP package set.
+
+It owns reusable Python helpers that were previously duplicated across
+`deped-personnel`, `deped-equipment`, and `deped-connectivity`, including:
+
+- text, identifier, date, phone, email, and position normalization
+- CSV row iteration and progress helpers
+- common governance entity helpers
+- shared personnel-loader utility functions
+- canonical constant tables and lookup-extension hooks
+
+This package does not own SQL schemas, workbook extraction, or SQLite artifact
+contracts. Those remain package-local in `deped-asset`.
+
+## Install
+
+Published dependency:
+
+```bash
+uv add deped-dcp-template
+```
+
+Local development against a sibling checkout:
+
+```toml
+[tool.uv.sources]
+deped-dcp-template = { path = "../deped-dcp-template" }
+```
+
+## Tests
+
+```bash
+uv run pytest -q
+```

deped_dcp_template-0.1.0/docs/architecture.md

@@ -0,0 +1,50 @@
+# Architecture
+
+## Purpose
+
+This repository centralizes runtime code that is shared across multiple DepEd
+DCP data-cleaning packages.
+
+The goal is to keep shared behavior consistent while leaving domain-specific
+artifact rules in the owning package.
+
+## Ownership Boundary
+
+`deped-dcp-template` owns:
+
+- reusable pure helpers
+- reusable constant tables
+- reusable CSV/progress helpers
+- reusable entity key and naming helpers
+- small shared loader utilities
+
+Consumer packages own:
+
+- SQL schema definitions
+- views and indexes
+- CLI entrypoints
+- domain-specific build pipelines
+- domain-specific normalization policy beyond the shared baseline
+
+## Public API
+
+Stable import surface:
+
+- `deped_dcp_template.constants`
+- `deped_dcp_template.cleaners`
+- `deped_dcp_template.io`
+- `deped_dcp_template.entities`
+- `deped_dcp_template.personnel`
+
+Consumers should prefer importing from these module boundaries rather than
+reaching into private implementation details.
+
+## Design Rules
+
+- Shared helpers must stay domain-agnostic unless a behavior is already reused
+  by multiple consumers.
+- Consumer packages must not import runtime code from each other.
+- Cross-domain data exchange should still happen through artifacts, not through
+  direct Python access to another package's database-building code.
+- If a helper change would alter domain semantics, the owning consumer package
+  should keep that overlay locally.

deped_dcp_template-0.1.0/docs/development.md

@@ -0,0 +1,40 @@
+# Development
+
+## Adding Shared Code
+
+Add code here only when all of the following are true:
+
+- the behavior is reused by more than one consumer package
+- the shared API can be expressed without pulling in domain-specific schema or
+  CLI concerns
+- the behavior has unit tests in this repository
+
+## Keeping Package Boundaries Clear
+
+Good candidates for this repo:
+
+- parsing helpers
+- normalization helpers
+- constant registries
+- reusable row-loading utilities
+
+Poor candidates for this repo:
+
+- SQL DDL
+- end-to-end build commands
+- workbook-specific extraction flows
+- package-specific audit outputs
+
+## Change Workflow
+
+1. Update the shared module in `src/deped_dcp_template/`.
+2. Add or update unit tests in `tests/`.
+3. Run `uv run pytest -q`.
+4. Verify downstream consumer packages still pass their own tests.
+
+## Compatibility Guidance
+
+- Keep public function names stable when possible.
+- Prefer additive changes over breaking renames.
+- If a consumer needs stricter behavior than the shared default, keep a local
+  wrapper or overlay in that consumer package.

deped_dcp_template-0.1.0/docs/getting-started.md

@@ -0,0 +1,57 @@
+# Getting Started
+
+## Requirements
+
+- Python 3.14+
+- `uv`
+
+## Install For Development
+
+From this repository:
+
+```bash
+uv sync
+```
+
+Run the package tests:
+
+```bash
+uv run pytest -q
+```
+
+## Use From a Consumer Repository
+
+Published dependency:
+
+```bash
+uv add deped-dcp-template
+```
+
+Sibling checkout during local development:
+
+```toml
+[tool.uv.sources]
+deped-dcp-template = { path = "../deped-dcp-template" }
+```
+
+Then import from the shared package:
+
+```python
+from deped_dcp_template.cleaners import parse_date
+from deped_dcp_template.io import iter_csv_rows
+```
+
+## Release Shape
+
+- distribution name: `deped-dcp-template`
+- import package: `deped_dcp_template`
+- build backend: `hatchling`
+
+## Current Test Scope
+
+The test suite currently covers:
+
+- parsing and normalization helpers
+- entity naming and natural-key helpers
+- low-cardinality alias registration
+- shared loader utility functions

deped_dcp_template-0.1.0/docs/index.md

@@ -0,0 +1,51 @@
+# deped-dcp-template
+
+`deped-dcp-template` is the shared runtime library used by the DepEd DCP
+package set.
+
+It exists to hold Python helpers that are reused by multiple domain packages so
+that `deped-personnel`, `deped-equipment`, and `deped-connectivity` do not
+carry divergent copies of the same normalization and loading code.
+
+## What This Repo Owns
+
+- shared text, identifier, date, phone, email, and position normalization
+- shared CSV iteration and progress helpers
+- shared governance entity helpers
+- shared personnel-loader utility helpers
+- shared canonical constant tables and extension hooks
+
+## What This Repo Does Not Own
+
+- SQLite schemas, indexes, and views
+- workbook extraction logic
+- domain-specific build orchestration
+- artifact contracts such as `lookups.db`, `personnel.db`, `equipment.db`, and
+  `connectivity.db`
+
+Those remain package-local in `deped-asset`.
+
+## Repository Layout
+
+```text
+src/deped_dcp_template/   Shared runtime package
+tests/                    Package-level unit tests
+docs/                     Repository documentation
+.github/workflows/        Release workflow
+```
+
+## Main Modules
+
+- `constants`: canonical constant tables and extension hooks
+- `cleaners`: reusable normalization and parsing helpers
+- `io`: CSV iteration and progress utilities
+- `entities`: shared governance entity naming and key helpers
+- `personnel`: shared loader helpers used by personnel-style import flows
+
+## Consumer Model
+
+Consumers should depend on the published `deped-dcp-template` package. During
+local development, sibling checkouts can be wired through `tool.uv.sources`.
+
+Read [Getting Started](getting-started.md) for setup and
+[Architecture](architecture.md) for ownership boundaries.

deped_dcp_template-0.1.0/env.example

@@ -0,0 +1 @@
+PYPI_TOKEN=op://dev/pypi/credential

deped_dcp_template-0.1.0/justfile

@@ -0,0 +1,10 @@
+set dotenv-load
+
+# create .env file from example
+dumpenv:
+  op inject -i env.example -o .env
+
+# upload to pypi
+publish:
+  uv build && \
+  UV_PUBLISH_TOKEN=$PYPI_TOKEN uv publish

deped_dcp_template-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "deped-dcp-template"
+version = "0.1.0"
+description = "Shared runtime helpers for DepEd DCP data-cleaning packages."
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+    "email-validator>=2.3.0",
+    "rich>=14.3.3",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = ["pytest>=9.0", "pytest-cov>=7.0","zensical>=0.0.31",]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/deped_dcp_template"]
+
+[tool.pytest.ini_options]
+minversion = "9.0"
+addopts = "-ra -q -vv --cov --doctest-modules"
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+ignore = ["F401", "F403", "E501"]
+fixable = ["F", "E", "W", "I001"]
+select = ["E", "F", "W", "I", "C"]

deped_dcp_template-0.1.0/src/deped_dcp_template/__init__.py

@@ -0,0 +1 @@
+"""Shared runtime helpers for DepEd DCP packages."""