Changelog¶

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v1.0.0 - 2026-08-13¶

Compare with v0.3.0

Added¶

• PHIX school validation: new validate_phix module cross-references schools and daycares in the input against the PHIX facility reference list for the selected PHU. Matches are classified exact when the normalized name is found in the PHU mapping and the facility IDs match. Configurable via parameters.yaml (#195).
• Bundle PHIX facility reference mapping (config/phix_mapping.json) with the package (#195).
• Add next-dose information to output: dose numbers in the overdue disease list, with a config flag to toggle dose info and validity markers on/off (#192).
• Add option to remove the border around the client information box in templates (#156).
• Add MkDocs documentation site with user guide, API reference, architecture overview, pipeline step reference, and developer guide, deployed via GitHub Actions.

Changed¶

• Rename project from "Immunization Charts (python Version)" to ImmuKnow in README and documentation.
• Merge ensure_required_columns into normalize_dataframe to eliminate a redundant preprocessing pass (#190).
• Expand and restructure test suite: renamed test modules, added E2E smoke test with encryption enabled, consolidated integration contract tests (#161).
• Update Typst to v0.14.2 in GitHub Actions CI.
• Multiple dependency updates (automated via Dependabot).

Fixed¶

• Resolve type checker errors flagged by ty (#160).
• Fix over_16 logic in test suite.

Security¶

• Remove contributor names and email addresses from committed files (#182).

v0.3.0 - 2026-01-09¶

Compare with first commit

Added¶

• Adding changes to immunization table for proper translation (8e1869d by kassyray).
• Adding logo size (4e40f42 by kassyray).
• Adding submodules to gitignore (ecce168 by kassyray).
• Adding address missingness checker #115 (64b8107 by kassyray).
• Adding row with incomplete address to the testing dataset for #115 (9930335 by kassyray).
• Add unit tests for map_columns function to verify exact and inexact column name mappings (d1fe172 by kassyray).
• Add threshold constant and update normalization logic in preprocess module (25c962a by kassyray).
• Add unit tests for normalize and filter_columns functions in preprocess module (26ca2d4 by kassyray).
• Add tests for custom template directory support, covering loading, assets, and compilation. Catch remaining issues with custom directories. (248357f by Justin Angevaare).
• Add template directory parameter to compilation functions (097bca2 by Justin Angevaare).
• Added rapidfuzz (fa0b163 by kassyray).
• Add docstring to map_columns function for clarity on parameters and behavior - cherry picked column mapper from another branch to clean up. #107 (1483cba by kassyray).
• Add template directory argument and validation in orchestrator (1b7ba28 by Justin Angevaare).
• Adding specific instructions about naming PHUs. Closes #45. (7a3f026 by kassyray).
• Added information about tools used and code coverage to documentation #100 (f1c17e8 by kassyray).
• Add envelope_window_height parameter to client_info_tbl functions and update table row height #70 (9c472c6 by kassyray).
• Added additional test for page_count type in test_validate_pdfs.py (assertion in test_validation_includes_measurements) (25bd931 by TiaTuinstra).
• Add childcare center designation to English and French template client info functions (f0d768e by kassyray).
• Add school_type parameter to client_info_tbl_en and client_info_tbl_fr functions (6007937 by kassyray).

Fixed¶

• Fixes #90 (9ef462e by kassyray).

Changed¶

• Changes to size so that french translation is formatted more nicely in header (89db891 by kassyray).