django-clade 0.0.5__tar.gz

django_clade-0.0.5/.codecov.yml

@@ -0,0 +1,92 @@
+# =============================================================================
+# .codecov.yml — Clade project
+# Coverage reporting configuration for codecov.io
+#
+# Validate: curl -X POST --data-binary @.codecov.yml https://codecov.io/validate
+#
+# Refs: DD-006 (test strategy), DD-009 (toolchain)
+# GitLab: #6, #9
+# =============================================================================
+
+# -----------------------------------------------------------------------------
+# Coverage targets
+# -----------------------------------------------------------------------------
+coverage:
+  precision: 2
+  round: down
+  status:
+    project:
+      default:
+        target: 80%          # minimum acceptable project coverage (DD-006)
+        threshold: 1%        # allow 1% drop before reporting a failure
+    patch:
+      default:
+        target: 80%          # new code in each MR must meet the same target
+        threshold: 1%
+
+# -----------------------------------------------------------------------------
+# Components — coverage by conceptual area (DD-001 to DD-004)
+# Paths will be populated as the module grows.
+# -----------------------------------------------------------------------------
+component_management:
+  default_rules:
+    statuses:
+      - type: project
+        target: 80%
+        threshold: 1%
+
+  individual_components:
+
+    - component_id: node_tree
+      name: "Node Tree"          # DD-001 — core tree model
+      paths:
+        - "src/clade/models/**"
+        - "src/clade/tree/**"
+
+    - component_id: kinship
+      name: "Kinship queries"    # DD-002 — parent, sibling, pibling, nibling…
+      paths:
+        - "src/clade/kinship/**"
+        - "src/clade/relations/**"
+
+    - component_id: backends
+      name: "Backends"           # DD-003 — ltree + fallback
+      paths:
+        - "src/clade/backends/**"
+
+    - component_id: affinity
+      name: "Affinity"           # DD-004 — lateral shared-attribute grouping
+      paths:
+        - "src/clade/affinity/**"
+
+# -----------------------------------------------------------------------------
+# Flags — by test type
+# -----------------------------------------------------------------------------
+flags:
+  unittests:
+    paths:
+      - src/clade/
+    carryforward: true
+
+# -----------------------------------------------------------------------------
+# Ignored paths
+# -----------------------------------------------------------------------------
+ignore:
+  - "src/clade/migrations/**"
+  - "tests/**"
+  - "docs/**"
+
+# -----------------------------------------------------------------------------
+# MR comments
+# -----------------------------------------------------------------------------
+comment:
+  layout: "reach,diff,components,flags,files"
+  behavior: default
+  require_changes: true
+
+# -----------------------------------------------------------------------------
+# Codecov behaviour
+# -----------------------------------------------------------------------------
+codecov:
+  notify:
+    after_n_builds: 1    # raise to 8 when full matrix is active

django_clade-0.0.5/.gitignore

@@ -0,0 +1,176 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# uv
+.uv/
+# uv.lock is intentionally not committed for a distributed module
+# (consumers manage their own dependency resolution).
+# uv.lock
+
+# Pyright
+.pyright/
+
+# Extended environment files
+.env.*
+!.env.example
+
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/

django_clade-0.0.5/.gitlab/issue_templates/bug.md

@@ -0,0 +1,60 @@
+# 🐛 Bug Report
+
+## Summary
+
+<!-- One sentence: what happens vs what should happen. -->
+
+**Observed:** 
+**Expected:** 
+
+---
+
+## Reproduction steps
+
+<!-- Minimal Python code reproducing the issue (MCVE). A failing pytest is ideal. -->
+
+```python
+
+```
+
+---
+
+## Environment
+
+| Field | Value |
+|---|---|
+| **Package version** | <!-- output of: pip show hierarchy \| grep Version --> |
+| **Python version** | <!-- output of: python --version --> |
+| **Django version** | <!-- output of: python -m django --version --> |
+| **OS** | <!-- Linux / macOS / Windows --> |
+
+---
+
+## Affected scope
+
+<!-- Check all that apply -->
+
+- [ ] `api` — public interface
+- [ ] `docs` — docstrings, examples
+- [ ] `tests` — pytest, coverage
+- [ ] `ci` — pipeline
+
+---
+
+## Severity
+
+<!-- Remove the lines that do not apply -->
+
+- **high** — unhandled exception, data corruption, public regression
+- **medium** — incorrect behaviour, workaround available
+- **low** — cosmetic, imprecise error message
+
+---
+
+## Additional context
+
+<!-- Full traceback, logs, pip freeze output, etc. -->
+
+---
+
+/label ~"type: bug" ~"status: triage" ~"priority: high"

django_clade-0.0.5/.gitlab/issue_templates/decision.md

@@ -0,0 +1,65 @@
+# 🧭 Design Decision (DD)
+
+## DD Identifier
+
+<!-- Three-digit sequential number — check existing closed DD issues for the next available.
+     Format: DD-NNN -->
+
+**DD-NNN**
+
+## Target version
+
+<!-- Project version where this decision takes effect (= milestone) -->
+
+---
+
+## Context
+
+<!-- Why is this decision necessary?
+     What constraint, gap, or opportunity motivates it? -->
+
+---
+
+## Options considered
+
+| Option | Advantage | Risk |
+|---|---|---|
+| **A** — | | |
+| **B** — | | |
+| **C** — | | |
+
+---
+
+## Decision
+
+<!-- The chosen option and a brief justification. -->
+
+---
+
+## Consequences
+
+<!-- Impact on the public API, dependencies, tests,
+     backward compatibility, or future decisions. -->
+
+- Related: <!-- #xx (DD-NNN) -->
+
+---
+
+## Affected scopes
+
+- [ ] `api` — public interface
+- [ ] `docs` — docstrings, guides
+- [ ] `tests` — pytest, coverage
+- [ ] `ci` — pipeline
+
+---
+
+## Closing checklist
+
+- [ ] Affected modules are identified
+- [ ] Implementation issues / MRs are linked
+- [ ] The `status: closed` label has been applied
+
+---
+
+/label ~"type: decision" ~"status: triage"

django_clade-0.0.5/.gitlab/issue_templates/feature.md

@@ -0,0 +1,61 @@
+# ✨ Feature Request
+
+## Why?
+
+<!-- What problem does this feature solve?
+     Which use case is currently impossible or cumbersome? -->
+
+---
+
+## What?
+
+<!-- Precise description of the desired feature. -->
+
+---
+
+## Acceptance criteria
+
+<!-- Verifiable conditions — each should map to a test or doc test. -->
+
+- [ ] `pytest` passes — coverage ≥ 80%
+- [ ] `ruff` and `pyright`: 0 errors
+- [ ] Existing public API unchanged (or breaking change documented)
+- [ ] `CHANGELOG.md` updated
+
+---
+
+## API sketch (optional)
+
+<!-- Proposed signatures, usage examples, or configuration structure. -->
+
+```python
+
+```
+
+---
+
+## Related Design Decisions
+
+<!-- DD issue numbers covering the associated architecture choices -->
+
+Refs: <!-- #xx (DD-NNN) -->
+
+---
+
+## Affected scope
+
+- [ ] `api` — public interface
+- [ ] `docs` — docstrings, guides
+- [ ] `tests` — pytest, coverage
+- [ ] `ci` — pipeline
+
+---
+
+## Breaking change?
+
+- [ ] No — backward-compatible
+- [ ] Yes — requires a minor or major version bump
+
+---
+
+/label ~"type: feature" ~"status: triage"

django_clade-0.0.5/.gitlab/issue_templates/maintenance.md

@@ -0,0 +1,58 @@
+# 🔧 Maintenance
+
+## Task type
+
+<!-- Remove the lines that do not apply, then update the label below -->
+
+- **chore** — dependencies, housekeeping, configuration
+- **docs** — docstrings, README, guides, examples
+- **test** — adding or fixing tests, coverage
+- **refactor** — restructuring without behaviour change
+- **ci** — pipeline, tox, GitLab CI
+- **perf** — performance optimisation
+- **deprecation** — mark obsolete code with deprecation warnings
+
+---
+
+## Description
+
+<!-- What needs to be done, and why now? -->
+
+---
+
+## Completion criteria
+
+- [ ] `tox -e lint,type,security` exits 0
+- [ ] `pytest` passes
+- [ ] Coverage ≥ 80%
+- [ ] `CHANGELOG.md` updated if necessary
+
+---
+
+## Urgency (optional)
+
+<!-- Why now rather than later?
+     E.g.: CVE, blocking technical debt, prerequisite for a feature. -->
+
+---
+
+## Dependency update detail (optional)
+
+<!-- Fill in only for a dependency-update chore -->
+
+| Package | Before | After | Breaking? |
+|---|---|---|---|
+|  |  |  |  |
+
+---
+
+## Affected scope
+
+- [ ] `api` — public interface
+- [ ] `docs` — docstrings, guides
+- [ ] `tests` — pytest, coverage
+- [ ] `ci` — pipeline
+
+---
+
+/label ~"status: triage"

django_clade-0.0.5/.gitlab/merge_request_templates/default.md

@@ -0,0 +1,42 @@
+# Description
+
+<!-- Brief description of the changes and their motivation.
+     What does this MR do, and why? -->
+
+---
+
+## Related issue
+
+Closes #<!-- issue number -->
+
+---
+
+## Type of change
+
+<!-- Remove the lines that do not apply -->
+
+- **feat** — new feature
+- **fix** — bug fix
+- **docs** — documentation only
+- **chore** — build, deps, configuration
+- **refactor** — code restructuring, no behaviour change
+- **test** — adding or fixing tests
+- **ci** — pipeline changes
+- **perf** — performance improvement
+
+---
+
+## Checklist
+
+- [ ] `tox -e lint,type,security` exits 0 locally
+- [ ] `pytest` passes locally
+- [ ] Coverage ≥ 80% (no regression)
+- [ ] `CHANGELOG.md` updated under `[Unreleased]`
+- [ ] Issue linked with `Closes #xx`
+- [ ] Breaking change documented (if applicable)
+
+---
+
+## Notes for reviewer (optional)
+
+<!-- Anything that needs special attention during review. -->

django_clade-0.0.5/.gitlab-ci.yml

@@ -0,0 +1,148 @@
+# =============================================================================
+# .gitlab-ci.yml — Hierarchy project
+#
+# Jobs:
+#   lint     — Ruff (every push)
+#   type     — Pyright (every push)
+#   security — Bandit (every push)
+#   test     — pytest + pytest-cov, full matrix (tag push only)
+#
+# Refs: DD-006 (test strategy), DD-009 (toolchain)
+# GitLab: #6, #9
+# =============================================================================
+
+default:
+  image: python:3.12-slim
+
+variables:
+  UV_VERSION: "latest"
+  PIP_NO_CACHE_DIR: "1"
+
+# -----------------------------------------------------------------------------
+# Pipeline rules
+# -----------------------------------------------------------------------------
+workflow:
+  rules:
+    - if: $CI_COMMIT_BRANCH          # every push on any branch
+    - if: $CI_COMMIT_TAG             # every tag push
+
+# -----------------------------------------------------------------------------
+# Stages
+# -----------------------------------------------------------------------------
+stages:
+  - quality    # lint, type, security — fast, runs on every push
+  - test       # pytest full matrix   — runs on tag only (DD-006)
+
+# -----------------------------------------------------------------------------
+# Shared setup — install uv and the project dev dependencies
+# -----------------------------------------------------------------------------
+.setup: &setup
+  before_script:
+    - pip install uv --quiet
+    - uv venv --quiet
+    - source .venv/bin/activate
+    - uv pip install -e ".[dev]" --quiet
+
+# -----------------------------------------------------------------------------
+# Quality stage — every push
+# -----------------------------------------------------------------------------
+lint:
+  stage: quality
+  <<: *setup
+  script:
+    - ruff check .
+    - ruff format --check .
+  rules:
+    - if: $CI_COMMIT_BRANCH
+    - if: $CI_COMMIT_TAG
+
+type:
+  stage: quality
+  <<: *setup
+  script:
+    - pyright
+  rules:
+    - if: $CI_COMMIT_BRANCH
+    - if: $CI_COMMIT_TAG
+
+security:
+  stage: quality
+  <<: *setup
+  script:
+    - bandit -c pyproject.toml -r hierarchy
+  rules:
+    - if: $CI_COMMIT_BRANCH
+    - if: $CI_COMMIT_TAG
+
+# -----------------------------------------------------------------------------
+# Test stage — tag push only (DD-006)
+# Full matrix: Python 3.10–3.13 × Django 5.2 LTS + Django latest
+# -----------------------------------------------------------------------------
+.test_base:
+  stage: test
+  script:
+    - pip install uv --quiet
+    - uv venv --quiet
+    - source .venv/bin/activate
+    - uv pip install django${DJANGO_VERSION} pytest pytest-django pytest-cov --quiet
+    - uv pip install -e . --quiet
+    - pytest --cov=hierarchy --cov-report=term-missing --cov-report=xml
+  coverage: '/TOTAL.*\s+(\d+%)$/'
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+    expire_in: 1 week
+  rules:
+    - if: $CI_COMMIT_TAG
+
+# Django 5.2 LTS
+test-py310-dj52:
+  extends: .test_base
+  image: python:3.10-slim
+  variables:
+    DJANGO_VERSION: "~=5.2"
+
+test-py311-dj52:
+  extends: .test_base
+  image: python:3.11-slim
+  variables:
+    DJANGO_VERSION: "~=5.2"
+
+test-py312-dj52:
+  extends: .test_base
+  image: python:3.12-slim
+  variables:
+    DJANGO_VERSION: "~=5.2"
+
+test-py313-dj52:
+  extends: .test_base
+  image: python:3.13-slim
+  variables:
+    DJANGO_VERSION: "~=5.2"
+
+# Django latest
+test-py310-djlatest:
+  extends: .test_base
+  image: python:3.10-slim
+  variables:
+    DJANGO_VERSION: ""
+
+test-py311-djlatest:
+  extends: .test_base
+  image: python:3.11-slim
+  variables:
+    DJANGO_VERSION: ""
+
+test-py312-djlatest:
+  extends: .test_base
+  image: python:3.12-slim
+  variables:
+    DJANGO_VERSION: ""
+
+test-py313-djlatest:
+  extends: .test_base
+  image: python:3.13-slim
+  variables:
+    DJANGO_VERSION: ""

django_clade-0.0.5/.tox-config/coverage-version.txt

@@ -0,0 +1,9 @@
+# =============================================================================
+# .tox-config/coverage-version.txt — Hierarchy project
+# =============================================================================
+# Version Python utilisée pour générer le rapport de couverture.
+# Une seule version active (première ligne non commentée).
+# Doit correspondre à un environnement défini dans pyproject.toml.
+# =============================================================================
+
+py312-dj52