helakit 0.1.0__tar.gz

helakit-0.1.0/.gitignore

@@ -0,0 +1,45 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*$py.class
+*.pyc
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+wheels/
+
+# Test / coverage
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+.pytest_cache/
+.hypothesis/
+
+# Type checkers / linters
+.mypy_cache/
+.ruff_cache/
+.pyre/
+.pytype/
+
+# mkdocs
+site/
+
+# Editors / IDEs
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db

helakit-0.1.0/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-04-29
+
+### Added
+
+- Initial scaffolding: package layout, validator stubs (NIC, phone, postal),
+  `ValidationResult` core, docs site, CI / docs / release workflows, and
+  development tooling (ruff, mypy, pytest, pre-commit).

helakit-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 <Your Name>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

helakit-0.1.0/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: helakit
+Version: 0.1.0
+Summary: A toolkit for validating and working with Sri Lankan data.
+Project-URL: Homepage, https://github.com/Aswikinz/Helakit
+Project-URL: Documentation, https://Aswikinz.github.io/Helakit/
+Project-URL: Repository, https://github.com/Aswikinz/Helakit
+Project-URL: Issues, https://github.com/Aswikinz/Helakit/issues
+Project-URL: Changelog, https://github.com/Aswikinz/Helakit/blob/main/CHANGELOG.md
+Author: The helakit authors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: nic,phone,postal,sri-lanka,validation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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 :: Software Development :: Libraries
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: hypothesis>=6; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pre-commit>=3.7; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mike>=2.1; extra == 'docs'
+Requires-Dist: mkdocs-gen-files>=0.5; extra == 'docs'
+Requires-Dist: mkdocs-literate-nav>=0.6; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
+Requires-Dist: mkdocs>=1.6; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.25; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# Helakit
+
+*A toolkit for validating and working with Sri Lankan data.*
+
+[![PyPI version](https://img.shields.io/pypi/v/helakit.svg)](https://pypi.org/project/helakit/)
+[![Python versions](https://img.shields.io/pypi/pyversions/helakit.svg)](https://pypi.org/project/helakit/)
+[![CI](https://github.com/Aswikinz/Helakit/actions/workflows/ci.yml/badge.svg)](https://github.com/Aswikinz/Helakit/actions/workflows/ci.yml)
+[![Coverage](https://img.shields.io/codecov/c/github/Aswikinz/Helakit)](https://codecov.io/gh/Aswikinz/Helakit)
+[![Docs](https://img.shields.io/badge/docs-online-blue)](https://Aswikinz.github.io/Helakit/)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+
+Helakit is a small, dependency-free Python library for validating and
+parsing Sri Lankan identifiers — NIC numbers, phone numbers, postal
+codes, and more. Each identifier lives in its own self-contained
+subpackage and shares a single result type, so adding a new validator
+is a matter of dropping in a folder.
+
+For usage and API reference, see the [docs](https://Aswikinz.github.io/Helakit/).
+This page is a tour of *how the project is laid out* — useful if you
+want to contribute, audit, or fork.
+
+## Design principles
+
+1. **Modular monolith.** Every validation domain (`nic`, `phone`,
+   `postal`, …) is a self-contained subpackage. Adding a new domain is
+   adding a new folder; no plugin system or registry to wire up.
+2. **Zero runtime dependencies.** The library itself uses only the
+   Python standard library. Dev and docs tools are kept in extras.
+3. **Data as Python dicts.** Lookup tables (provinces, districts,
+   mobile prefixes, NIC encoding rules) live as module-level `dict`
+   constants in `.py` files, not JSON / Parquet / SQLite. Lookups are
+   O(1) and cost nothing after import.
+4. **One result shape, two entry points.** Every validator exposes
+   both a rich `validate_X(value) -> ValidationResult` and a boolean
+   `is_valid_X(value) -> bool`. `ValidationResult` is truthy when
+   valid, so the rich form drops into `if` statements naturally.
+5. **`src/` layout.** Tests run against the *installed* package, not
+   the source tree, so packaging mistakes can't masquerade as passing
+   tests.
+6. **Strict typing end to end.** A `py.typed` marker ships with the
+   wheel and CI runs `mypy --strict`. Type hints use modern syntax
+   (`X | Y`, `list[X]`, `dict[K, V]`).
+
+## Repository layout
+
+```text
+src/helakit/
+├── __init__.py        # public API surface + __version__
+├── py.typed           # PEP 561 marker
+├── _core/             # shared primitives, no domain logic
+│   ├── result.py      # ValidationResult + ValidationError dataclasses
+│   ├── base.py        # Validator Protocol
+│   └── exceptions.py  # HelakitError hierarchy
+├── _data/             # cross-domain lookup tables (provinces, districts, …)
+└── <domain>/          # one folder per identifier type
+    ├── __init__.py    # re-exports validate_X / is_valid_X
+    ├── validator.py   # the actual rules
+    ├── exceptions.py  # domain-specific exceptions
+    └── _data.py       # domain-specific lookup tables (optional)
+```
+
+Domains currently in the tree: `nic/`, `phone/`, `postal/`. The
+underscore-prefixed packages (`_core/`, `_data/`) are private —
+nothing outside the package should import from them.
+
+Around the source:
+
+```text
+tests/                 # mirror of src/helakit/, one folder per domain
+docs/                  # MkDocs site (Material theme, mike for versioning)
+.github/workflows/     # ci.yml, docs.yml, release.yml
+pyproject.toml         # hatchling build, ruff, mypy, pytest, coverage config
+```
+
+## How a domain is structured
+
+Each domain is independent. The contract:
+
+- `validate_X(value: str) -> ValidationResult` — full validation,
+  returns parsed fields in `result.data` and structured errors in
+  `result.errors`.
+- `is_valid_X(value: str) -> bool` — boolean shorthand.
+- A domain-specific `XError` exception class inheriting from
+  `HelakitError`, for unrecoverable misuse (not validation failures —
+  those go through `ValidationResult`).
+- A `_data.py` for any tables only that domain cares about.
+
+The `__init__.py` re-exports the two functions and the exception, and
+the top-level `helakit/__init__.py` re-exports them again so users can
+write `from helakit import validate_nic` without thinking about layout.
+
+## Validators
+
+| Validator | Function          | Status      |
+| --------- | ----------------- | ----------- |
+| NIC       | `validate_nic`    | In progress |
+| Phone     | `validate_phone`  | Planned     |
+| Postal    | `validate_postal` | Planned     |
+| Passport  | (planned)         | Planned     |
+| Vehicle   | (planned)         | Planned     |
+
+More (driving licence numbers, BR numbers, …) will follow. Stubs for
+unimplemented validators raise `NotImplementedError` so call-sites
+written against the planned API don't silently no-op.
+
+## Adding a new validator
+
+1. Create `src/helakit/<domain>/` mirroring the layout above.
+2. Add a `tests/test_<domain>/` folder with at least one test for the
+   happy path and one for each error class.
+3. Add a `docs/validators/<domain>.md` page.
+4. Re-export the public functions from `src/helakit/__init__.py`.
+5. Add a `## [Unreleased]` entry to `CHANGELOG.md`.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the dev-environment setup
+and the PR checklist.
+
+## Data contributions
+
+A lot of helakit's value lives in its lookup tables. Adding or
+correcting entries (postal codes, mobile prefixes, district names) is
+the easiest way to contribute and doesn't require deep Python — each
+table is a plain `dict` in `src/helakit/_data/` or
+`src/helakit/<domain>/_data.py`. Cite a source in the PR description
+so we can verify it.
+
+## Documentation
+
+Docs are versioned with [mike](https://github.com/jimporter/mike) and
+published in three flavours:
+
+- `/dev/` — built from every push to `main`. Tracks in-progress work.
+- `/<MAJOR>.<MINOR>/` — built from each release tag. Frozen.
+- `/latest/` — alias for the most recent release.
+
+The bare site URL ([Aswikinz.github.io/Helakit](https://Aswikinz.github.io/Helakit/))
+redirects to `/latest/` once a release exists, and to `/dev/` until then.
+
+Links: [docs](https://Aswikinz.github.io/Helakit/) ·
+[dev](https://Aswikinz.github.io/Helakit/dev/) ·
+[changelog](CHANGELOG.md) ·
+[contributing](CONTRIBUTING.md).
+
+## Install
+
+```bash
+pip install helakit
+```
+
+Requires Python 3.10+.
+
+## Status
+
+Helakit is alpha software. The public API may change before 1.0; pin
+versions accordingly.
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE).

helakit-0.1.0/README.md

@@ -0,0 +1,159 @@
+# Helakit
+
+*A toolkit for validating and working with Sri Lankan data.*
+
+[![PyPI version](https://img.shields.io/pypi/v/helakit.svg)](https://pypi.org/project/helakit/)
+[![Python versions](https://img.shields.io/pypi/pyversions/helakit.svg)](https://pypi.org/project/helakit/)
+[![CI](https://github.com/Aswikinz/Helakit/actions/workflows/ci.yml/badge.svg)](https://github.com/Aswikinz/Helakit/actions/workflows/ci.yml)
+[![Coverage](https://img.shields.io/codecov/c/github/Aswikinz/Helakit)](https://codecov.io/gh/Aswikinz/Helakit)
+[![Docs](https://img.shields.io/badge/docs-online-blue)](https://Aswikinz.github.io/Helakit/)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+
+Helakit is a small, dependency-free Python library for validating and
+parsing Sri Lankan identifiers — NIC numbers, phone numbers, postal
+codes, and more. Each identifier lives in its own self-contained
+subpackage and shares a single result type, so adding a new validator
+is a matter of dropping in a folder.
+
+For usage and API reference, see the [docs](https://Aswikinz.github.io/Helakit/).
+This page is a tour of *how the project is laid out* — useful if you
+want to contribute, audit, or fork.
+
+## Design principles
+
+1. **Modular monolith.** Every validation domain (`nic`, `phone`,
+   `postal`, …) is a self-contained subpackage. Adding a new domain is
+   adding a new folder; no plugin system or registry to wire up.
+2. **Zero runtime dependencies.** The library itself uses only the
+   Python standard library. Dev and docs tools are kept in extras.
+3. **Data as Python dicts.** Lookup tables (provinces, districts,
+   mobile prefixes, NIC encoding rules) live as module-level `dict`
+   constants in `.py` files, not JSON / Parquet / SQLite. Lookups are
+   O(1) and cost nothing after import.
+4. **One result shape, two entry points.** Every validator exposes
+   both a rich `validate_X(value) -> ValidationResult` and a boolean
+   `is_valid_X(value) -> bool`. `ValidationResult` is truthy when
+   valid, so the rich form drops into `if` statements naturally.
+5. **`src/` layout.** Tests run against the *installed* package, not
+   the source tree, so packaging mistakes can't masquerade as passing
+   tests.
+6. **Strict typing end to end.** A `py.typed` marker ships with the
+   wheel and CI runs `mypy --strict`. Type hints use modern syntax
+   (`X | Y`, `list[X]`, `dict[K, V]`).
+
+## Repository layout
+
+```text
+src/helakit/
+├── __init__.py        # public API surface + __version__
+├── py.typed           # PEP 561 marker
+├── _core/             # shared primitives, no domain logic
+│   ├── result.py      # ValidationResult + ValidationError dataclasses
+│   ├── base.py        # Validator Protocol
+│   └── exceptions.py  # HelakitError hierarchy
+├── _data/             # cross-domain lookup tables (provinces, districts, …)
+└── <domain>/          # one folder per identifier type
+    ├── __init__.py    # re-exports validate_X / is_valid_X
+    ├── validator.py   # the actual rules
+    ├── exceptions.py  # domain-specific exceptions
+    └── _data.py       # domain-specific lookup tables (optional)
+```
+
+Domains currently in the tree: `nic/`, `phone/`, `postal/`. The
+underscore-prefixed packages (`_core/`, `_data/`) are private —
+nothing outside the package should import from them.
+
+Around the source:
+
+```text
+tests/                 # mirror of src/helakit/, one folder per domain
+docs/                  # MkDocs site (Material theme, mike for versioning)
+.github/workflows/     # ci.yml, docs.yml, release.yml
+pyproject.toml         # hatchling build, ruff, mypy, pytest, coverage config
+```
+
+## How a domain is structured
+
+Each domain is independent. The contract:
+
+- `validate_X(value: str) -> ValidationResult` — full validation,
+  returns parsed fields in `result.data` and structured errors in
+  `result.errors`.
+- `is_valid_X(value: str) -> bool` — boolean shorthand.
+- A domain-specific `XError` exception class inheriting from
+  `HelakitError`, for unrecoverable misuse (not validation failures —
+  those go through `ValidationResult`).
+- A `_data.py` for any tables only that domain cares about.
+
+The `__init__.py` re-exports the two functions and the exception, and
+the top-level `helakit/__init__.py` re-exports them again so users can
+write `from helakit import validate_nic` without thinking about layout.
+
+## Validators
+
+| Validator | Function          | Status      |
+| --------- | ----------------- | ----------- |
+| NIC       | `validate_nic`    | In progress |
+| Phone     | `validate_phone`  | Planned     |
+| Postal    | `validate_postal` | Planned     |
+| Passport  | (planned)         | Planned     |
+| Vehicle   | (planned)         | Planned     |
+
+More (driving licence numbers, BR numbers, …) will follow. Stubs for
+unimplemented validators raise `NotImplementedError` so call-sites
+written against the planned API don't silently no-op.
+
+## Adding a new validator
+
+1. Create `src/helakit/<domain>/` mirroring the layout above.
+2. Add a `tests/test_<domain>/` folder with at least one test for the
+   happy path and one for each error class.
+3. Add a `docs/validators/<domain>.md` page.
+4. Re-export the public functions from `src/helakit/__init__.py`.
+5. Add a `## [Unreleased]` entry to `CHANGELOG.md`.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the dev-environment setup
+and the PR checklist.
+
+## Data contributions
+
+A lot of helakit's value lives in its lookup tables. Adding or
+correcting entries (postal codes, mobile prefixes, district names) is
+the easiest way to contribute and doesn't require deep Python — each
+table is a plain `dict` in `src/helakit/_data/` or
+`src/helakit/<domain>/_data.py`. Cite a source in the PR description
+so we can verify it.
+
+## Documentation
+
+Docs are versioned with [mike](https://github.com/jimporter/mike) and
+published in three flavours:
+
+- `/dev/` — built from every push to `main`. Tracks in-progress work.
+- `/<MAJOR>.<MINOR>/` — built from each release tag. Frozen.
+- `/latest/` — alias for the most recent release.
+
+The bare site URL ([Aswikinz.github.io/Helakit](https://Aswikinz.github.io/Helakit/))
+redirects to `/latest/` once a release exists, and to `/dev/` until then.
+
+Links: [docs](https://Aswikinz.github.io/Helakit/) ·
+[dev](https://Aswikinz.github.io/Helakit/dev/) ·
+[changelog](CHANGELOG.md) ·
+[contributing](CONTRIBUTING.md).
+
+## Install
+
+```bash
+pip install helakit
+```
+
+Requires Python 3.10+.
+
+## Status
+
+Helakit is alpha software. The public API may change before 1.0; pin
+versions accordingly.
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE).

helakit-0.1.0/pyproject.toml

@@ -0,0 +1,108 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "helakit"
+description = "A toolkit for validating and working with Sri Lankan data."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "The helakit authors" }]
+keywords = ["sri-lanka", "validation", "nic", "phone", "postal"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "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 :: Software Development :: Libraries",
+]
+dynamic = ["version"]
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8",
+    "pytest-cov>=5",
+    "hypothesis>=6",
+    "mypy>=1.10",
+    "ruff>=0.5",
+    "pre-commit>=3.7",
+]
+docs = [
+    "mkdocs>=1.6",
+    "mkdocs-material>=9.5",
+    "mkdocstrings[python]>=0.25",
+    "mkdocs-gen-files>=0.5",
+    "mkdocs-literate-nav>=0.6",
+    "mike>=2.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/Aswikinz/Helakit"
+Documentation = "https://Aswikinz.github.io/Helakit/"
+Repository = "https://github.com/Aswikinz/Helakit"
+Issues = "https://github.com/Aswikinz/Helakit/issues"
+Changelog = "https://github.com/Aswikinz/Helakit/blob/main/CHANGELOG.md"
+
+[tool.hatch.version]
+path = "src/helakit/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/helakit"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/helakit",
+    "tests",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE",
+    "pyproject.toml",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM", "RUF"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = ["B", "SIM"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["helakit"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+files = ["src"]
+warn_unused_configs = true
+
+[[tool.mypy.overrides]]
+module = "helakit.*"
+disallow_any_unimported = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "--cov=helakit --cov-report=term-missing --cov-report=xml --strict-markers"
+
+[tool.coverage.run]
+branch = true
+source = ["helakit"]
+
+[tool.coverage.report]
+fail_under = 90
+show_missing = true
+skip_covered = false
+exclude_also = [
+    "raise NotImplementedError",
+    "if TYPE_CHECKING:",
+    "@overload",
+]

helakit-0.1.0/src/helakit/__init__.py

@@ -0,0 +1,23 @@
+"""Helakit — a toolkit for validating and working with Sri Lankan data."""
+
+from helakit._core.exceptions import HelakitError, InvalidInputError
+from helakit._core.result import ValidationError, ValidationResult
+from helakit.nic import is_valid_nic, validate_nic
+from helakit.phone import is_valid_phone, validate_phone
+from helakit.postal import is_valid_postal, validate_postal
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "HelakitError",
+    "InvalidInputError",
+    "ValidationError",
+    "ValidationResult",
+    "__version__",
+    "is_valid_nic",
+    "is_valid_phone",
+    "is_valid_postal",
+    "validate_nic",
+    "validate_phone",
+    "validate_postal",
+]

helakit-0.1.0/src/helakit/_core/__init__.py

@@ -0,0 +1,13 @@
+"""Core primitives: ``ValidationResult``, the ``Validator`` protocol, and exceptions."""
+
+from helakit._core.base import Validator
+from helakit._core.exceptions import HelakitError, InvalidInputError
+from helakit._core.result import ValidationError, ValidationResult
+
+__all__ = [
+    "HelakitError",
+    "InvalidInputError",
+    "ValidationError",
+    "ValidationResult",
+    "Validator",
+]

helakit-0.1.0/src/helakit/_core/base.py

@@ -0,0 +1,28 @@
+"""The ``Validator`` protocol that every domain validator implements."""
+
+from __future__ import annotations
+
+from typing import Protocol, runtime_checkable
+
+from helakit._core.result import ValidationResult
+
+
+@runtime_checkable
+class Validator(Protocol):
+    """Structural type for any object that validates Sri Lankan data.
+
+    Implementations expose a short ``name`` (e.g. ``"nic"``) along with two
+    parallel entry points: a rich :meth:`validate` returning a
+    :class:`~helakit._core.result.ValidationResult`, and a boolean
+    :meth:`is_valid` shorthand.
+    """
+
+    name: str
+
+    def validate(self, value: str) -> ValidationResult:
+        """Run full validation and return a structured result."""
+        ...
+
+    def is_valid(self, value: str) -> bool:
+        """Return ``True`` if ``value`` is valid, ``False`` otherwise."""
+        ...

helakit-0.1.0/src/helakit/_core/exceptions.py

@@ -0,0 +1,21 @@
+"""Exception hierarchy for programmer errors raised by helakit.
+
+Validation *failures* are reported through :class:`ValidationResult` rather
+than exceptions; the classes here represent unrecoverable misuse — for
+example, passing ``None`` where a string is required.
+"""
+
+from __future__ import annotations
+
+
+class HelakitError(Exception):
+    """Base class for every exception raised by helakit."""
+
+
+class InvalidInputError(HelakitError):
+    """Raised when an input is the wrong type or otherwise unusable.
+
+    This signals a programmer error, not a validation failure. A malformed
+    NIC string returns a :class:`ValidationResult` with ``is_valid=False``;
+    passing ``None`` instead of a string raises this.
+    """

helakit-0.1.0/src/helakit/_core/result.py

@@ -0,0 +1,53 @@
+"""Result types returned by every validator."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Any
+
+
+@dataclass(frozen=True, slots=True)
+class ValidationError:
+    """A single validation failure.
+
+    Attributes:
+        code: A short machine-readable identifier (e.g. ``"nic.bad_checksum"``).
+        message: A human-readable description of what went wrong.
+        field: The specific field within the input that failed, if applicable.
+    """
+
+    code: str
+    message: str
+    field: str | None = None
+
+
+@dataclass(frozen=True, slots=True)
+class ValidationResult:
+    """The outcome of validating a single value.
+
+    Attributes:
+        is_valid: ``True`` if the input passed every check.
+        value: The original input string, unmodified.
+        normalized: The canonical representation of ``value`` when valid.
+        errors: Every error encountered. Empty when ``is_valid`` is ``True``.
+        data: Structured fields extracted during validation (e.g. NIC date of
+            birth, gender). Empty when no fields could be extracted.
+    """
+
+    is_valid: bool
+    value: str
+    normalized: str | None = None
+    errors: list[ValidationError] = field(default_factory=list)
+    data: dict[str, Any] = field(default_factory=dict)
+
+    def __bool__(self) -> bool:
+        return self.is_valid
+
+    def __repr__(self) -> str:
+        if self.is_valid:
+            return (
+                f"ValidationResult(is_valid=True, value={self.value!r}, "
+                f"normalized={self.normalized!r}, data={self.data!r})"
+            )
+        codes = [e.code for e in self.errors]
+        return f"ValidationResult(is_valid=False, value={self.value!r}, errors={codes!r})"

helakit-0.1.0/src/helakit/_data/__init__.py

@@ -0,0 +1,5 @@
+"""Static lookup tables used across validators.
+
+Every entry here is a plain Python ``dict`` constant living in its own
+module. Importing the package is essentially free; lookups are O(1).
+"""

helakit-0.1.0/src/helakit/_data/districts.py

@@ -0,0 +1,15 @@
+"""Districts of Sri Lanka, keyed by short code.
+
+Placeholder data — the remaining districts will be added alongside the
+postal-code validator.
+"""
+
+from __future__ import annotations
+
+from typing import Final
+
+DISTRICTS: Final[dict[str, str]] = {
+    "CMB": "Colombo",
+    "KAN": "Kandy",
+    "GAL": "Galle",
+}

helakit-0.1.0/src/helakit/_data/provinces.py

@@ -0,0 +1,15 @@
+"""Provinces of Sri Lanka, keyed by short code.
+
+Placeholder data — the remaining provinces will be added alongside the
+postal-code validator.
+"""
+
+from __future__ import annotations
+
+from typing import Final
+
+PROVINCES: Final[dict[str, str]] = {
+    "WP": "Western",
+    "CP": "Central",
+    "SP": "Southern",
+}

helakit-0.1.0/src/helakit/nic/__init__.py

@@ -0,0 +1,10 @@
+"""NIC (National Identity Card) validation."""
+
+from helakit.nic.exceptions import NICError
+from helakit.nic.validator import is_valid_nic, validate_nic
+
+__all__ = [
+    "NICError",
+    "is_valid_nic",
+    "validate_nic",
+]

helakit-0.1.0/src/helakit/nic/_data.py

@@ -0,0 +1,18 @@
+"""Constants used while decoding NIC numbers.
+
+Sri Lankan NICs encode the holder's date of birth as the day-of-year, with
+female DOBs offset by 500. Old-format NICs use a two-digit year and end in
+a letter (V/X) for voting eligibility; new-format NICs are fully numeric
+and use a four-digit year. The exact encoding rules will live here.
+"""
+
+from __future__ import annotations
+
+from typing import Final
+
+OLD_FORMAT_LENGTH: Final[int] = 10
+NEW_FORMAT_LENGTH: Final[int] = 12
+
+FEMALE_DAY_OFFSET: Final[int] = 500
+
+OLD_FORMAT_SUFFIXES: Final[frozenset[str]] = frozenset({"V", "X"})

helakit-0.1.0/src/helakit/nic/exceptions.py

@@ -0,0 +1,9 @@
+"""NIC-specific exceptions."""
+
+from __future__ import annotations
+
+from helakit._core.exceptions import HelakitError
+
+
+class NICError(HelakitError):
+    """Raised for unrecoverable NIC-related programmer errors."""

helakit-0.1.0/src/helakit/nic/validator.py

@@ -0,0 +1,38 @@
+"""NIC validation entry points.
+
+Both :func:`validate_nic` and :func:`is_valid_nic` are stubs for now and
+will be implemented in a follow-up release.
+"""
+
+from __future__ import annotations
+
+from helakit._core.result import ValidationResult
+
+
+def validate_nic(value: str) -> ValidationResult:
+    """Validate a Sri Lankan NIC number and return a structured result.
+
+    Args:
+        value: The NIC number as a string. Both old (e.g. ``"901234567V"``)
+            and new (e.g. ``"199012345678"``) formats will be accepted.
+
+    Returns:
+        A :class:`ValidationResult` with parsed fields (date of birth,
+        gender, voting eligibility, …) populated when valid.
+
+    Raises:
+        NotImplementedError: NIC validation has not been implemented yet.
+    """
+    raise NotImplementedError("Coming in a future release")
+
+
+def is_valid_nic(value: str) -> bool:
+    """Return ``True`` if ``value`` is a valid Sri Lankan NIC number.
+
+    Args:
+        value: The NIC number as a string.
+
+    Raises:
+        NotImplementedError: NIC validation has not been implemented yet.
+    """
+    raise NotImplementedError("Coming in a future release")

helakit-0.1.0/src/helakit/phone/__init__.py

@@ -0,0 +1,10 @@
+"""Sri Lankan phone-number validation."""
+
+from helakit.phone.exceptions import PhoneError
+from helakit.phone.validator import is_valid_phone, validate_phone
+
+__all__ = [
+    "PhoneError",
+    "is_valid_phone",
+    "validate_phone",
+]

helakit-0.1.0/src/helakit/phone/exceptions.py

@@ -0,0 +1,9 @@
+"""Phone-specific exceptions."""
+
+from __future__ import annotations
+
+from helakit._core.exceptions import HelakitError
+
+
+class PhoneError(HelakitError):
+    """Raised for unrecoverable phone-related programmer errors."""

helakit-0.1.0/src/helakit/phone/validator.py

@@ -0,0 +1,31 @@
+"""Phone-number validation entry points (stub)."""
+
+from __future__ import annotations
+
+from helakit._core.result import ValidationResult
+
+
+def validate_phone(value: str) -> ValidationResult:
+    """Validate a Sri Lankan phone number.
+
+    Args:
+        value: The phone number, either local (``"0712345678"``) or
+            international (``"+94712345678"``) form.
+
+    Returns:
+        A :class:`ValidationResult` with the carrier and number type
+        populated when valid.
+
+    Raises:
+        NotImplementedError: Phone validation has not been implemented yet.
+    """
+    raise NotImplementedError("Coming in a future release")
+
+
+def is_valid_phone(value: str) -> bool:
+    """Return ``True`` if ``value`` is a valid Sri Lankan phone number.
+
+    Raises:
+        NotImplementedError: Phone validation has not been implemented yet.
+    """
+    raise NotImplementedError("Coming in a future release")

helakit-0.1.0/src/helakit/postal/__init__.py

@@ -0,0 +1,10 @@
+"""Sri Lankan postal-code validation."""
+
+from helakit.postal.exceptions import PostalError
+from helakit.postal.validator import is_valid_postal, validate_postal
+
+__all__ = [
+    "PostalError",
+    "is_valid_postal",
+    "validate_postal",
+]

helakit-0.1.0/src/helakit/postal/exceptions.py

@@ -0,0 +1,9 @@
+"""Postal-code-specific exceptions."""
+
+from __future__ import annotations
+
+from helakit._core.exceptions import HelakitError
+
+
+class PostalError(HelakitError):
+    """Raised for unrecoverable postal-code-related programmer errors."""

helakit-0.1.0/src/helakit/postal/validator.py

@@ -0,0 +1,30 @@
+"""Postal-code validation entry points (stub)."""
+
+from __future__ import annotations
+
+from helakit._core.result import ValidationResult
+
+
+def validate_postal(value: str) -> ValidationResult:
+    """Validate a Sri Lankan postal code.
+
+    Args:
+        value: A five-digit postal code.
+
+    Returns:
+        A :class:`ValidationResult` with the matching district and
+        province populated when valid.
+
+    Raises:
+        NotImplementedError: Postal-code validation has not been implemented yet.
+    """
+    raise NotImplementedError("Coming in a future release")
+
+
+def is_valid_postal(value: str) -> bool:
+    """Return ``True`` if ``value`` is a valid Sri Lankan postal code.
+
+    Raises:
+        NotImplementedError: Postal-code validation has not been implemented yet.
+    """
+    raise NotImplementedError("Coming in a future release")

helakit-0.1.0/tests/conftest.py

@@ -0,0 +1,5 @@
+"""Shared pytest fixtures.
+
+Currently empty — added so domain-specific conftests have a parent and so
+pytest's rootdir resolution stays predictable.
+"""

helakit-0.1.0/tests/test_core/test_data.py

@@ -0,0 +1,29 @@
+"""Smoke tests for the static lookup tables."""
+
+from __future__ import annotations
+
+from helakit._data.districts import DISTRICTS
+from helakit._data.provinces import PROVINCES
+from helakit.nic._data import (
+    FEMALE_DAY_OFFSET,
+    NEW_FORMAT_LENGTH,
+    OLD_FORMAT_LENGTH,
+    OLD_FORMAT_SUFFIXES,
+)
+
+
+def test_provinces_table_has_entries() -> None:
+    assert PROVINCES
+    assert all(isinstance(k, str) and isinstance(v, str) for k, v in PROVINCES.items())
+
+
+def test_districts_table_has_entries() -> None:
+    assert DISTRICTS
+    assert all(isinstance(k, str) and isinstance(v, str) for k, v in DISTRICTS.items())
+
+
+def test_nic_format_constants() -> None:
+    assert OLD_FORMAT_LENGTH == 10
+    assert NEW_FORMAT_LENGTH == 12
+    assert FEMALE_DAY_OFFSET == 500
+    assert OLD_FORMAT_SUFFIXES == frozenset({"V", "X"})

helakit-0.1.0/tests/test_core/test_result.py

@@ -0,0 +1,60 @@
+"""Tests for :class:`ValidationResult` and :class:`ValidationError`."""
+
+from __future__ import annotations
+
+import pytest
+
+from helakit import ValidationError, ValidationResult
+
+
+def test_valid_result_is_truthy() -> None:
+    result = ValidationResult(is_valid=True, value="x", normalized="X")
+    assert result
+    assert bool(result) is True
+
+
+def test_invalid_result_is_falsy() -> None:
+    result = ValidationResult(
+        is_valid=False,
+        value="x",
+        errors=[ValidationError(code="bad", message="nope")],
+    )
+    assert not result
+    assert bool(result) is False
+
+
+def test_default_collections_are_independent() -> None:
+    a = ValidationResult(is_valid=True, value="a")
+    b = ValidationResult(is_valid=True, value="b")
+    assert a.errors is not b.errors
+    assert a.data is not b.data
+
+
+def test_repr_distinguishes_valid_from_invalid() -> None:
+    valid = ValidationResult(is_valid=True, value="x", normalized="X", data={"k": 1})
+    invalid = ValidationResult(
+        is_valid=False,
+        value="x",
+        errors=[ValidationError(code="bad", message="nope")],
+    )
+    assert "is_valid=True" in repr(valid)
+    assert "'k': 1" in repr(valid)
+    assert "is_valid=False" in repr(invalid)
+    assert "'bad'" in repr(invalid)
+
+
+def test_result_is_frozen() -> None:
+    result = ValidationResult(is_valid=True, value="x")
+    with pytest.raises(AttributeError):
+        result.is_valid = False  # type: ignore[misc]
+
+
+def test_error_is_frozen() -> None:
+    error = ValidationError(code="bad", message="nope")
+    with pytest.raises(AttributeError):
+        error.code = "other"  # type: ignore[misc]
+
+
+def test_error_field_defaults_to_none() -> None:
+    error = ValidationError(code="bad", message="nope")
+    assert error.field is None

helakit-0.1.0/tests/test_nic/test_validator.py

@@ -0,0 +1,17 @@
+"""Placeholder tests for the NIC validator stubs."""
+
+from __future__ import annotations
+
+import pytest
+
+from helakit import is_valid_nic, validate_nic
+
+
+def test_validate_nic_is_stubbed() -> None:
+    with pytest.raises(NotImplementedError):
+        validate_nic("199012345678")
+
+
+def test_is_valid_nic_is_stubbed() -> None:
+    with pytest.raises(NotImplementedError):
+        is_valid_nic("199012345678")

helakit-0.1.0/tests/test_phone/test_validator.py

@@ -0,0 +1,17 @@
+"""Placeholder tests for the phone validator stubs."""
+
+from __future__ import annotations
+
+import pytest
+
+from helakit import is_valid_phone, validate_phone
+
+
+def test_validate_phone_is_stubbed() -> None:
+    with pytest.raises(NotImplementedError):
+        validate_phone("0712345678")
+
+
+def test_is_valid_phone_is_stubbed() -> None:
+    with pytest.raises(NotImplementedError):
+        is_valid_phone("0712345678")

helakit-0.1.0/tests/test_postal/test_validator.py

@@ -0,0 +1,17 @@
+"""Placeholder tests for the postal-code validator stubs."""
+
+from __future__ import annotations
+
+import pytest
+
+from helakit import is_valid_postal, validate_postal
+
+
+def test_validate_postal_is_stubbed() -> None:
+    with pytest.raises(NotImplementedError):
+        validate_postal("10100")
+
+
+def test_is_valid_postal_is_stubbed() -> None:
+    with pytest.raises(NotImplementedError):
+        is_valid_postal("10100")