tax-engine 0.1.0__tar.gz

tax_engine-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

tax_engine-0.1.0/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: tax-engine
+Version: 0.1.0
+Summary: Open-source personal income tax calculation engine in Python. Every number is a tax-form line, and every result explains itself in a readable trace.
+Author-email: Umar Khan <The-Pied-Piper@users.noreply.github.com>
+License-Expression: Apache-2.0
+Project-URL: Documentation, https://github.com/The-Pied-Piper/tax-engine#readme
+Project-URL: Repository, https://github.com/The-Pied-Piper/tax-engine
+Project-URL: Issues, https://github.com/The-Pied-Piper/tax-engine/issues
+Keywords: tax,income-tax,tax-calculation,canada,ontario,decimal,explainable
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: import-linter>=2.0; extra == "dev"
+Requires-Dist: mypy>=1.11; extra == "dev"
+Requires-Dist: pytest>=8.3; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
+Dynamic: license-file
+
+# tax-engine: an open-source income tax calculation engine in Python
+
+[![CI](https://github.com/The-Pied-Piper/tax-engine/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/The-Pied-Piper/tax-engine/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://www.python.org/downloads/)
+
+**tax-engine is a personal income tax calculation library where every number is a line on a real tax form, and every result explains itself in a readable trace.**
+
+Tax rules live as data taken as printed from the tax authority's own forms. Each form line is one small, tested step. You can follow any figure back to the form line it came from.
+
+Supported today: Canada (federal), Ontario and Alberta, tax years 2025 and 2026 (2026 is provisional). More forms, lines, years and jurisdictions are added over time (see [Coverage](#coverage)).
+
+## Example: a $70,000 salary (tax year 2025)
+
+Given only a gross salary, the engine works out the contributions and tax from the CRA forms. Take-home is then salary minus CPP, EI and total tax, a subtraction done by the caller outside the engine:
+
+| Item | Amount |
+| --- | ---: |
+| Federal tax | 7,585.64 |
+| Ontario tax (ON428, incl. health premium) | 3,911.45 |
+| **Total tax** | **11,497.09** |
+| CPP contributions (base 3,291.75 + enhanced 665.00) | 3,956.75 |
+| EI premiums | 1,077.48 |
+| **Take-home** | **53,468.68** |
+
+Every figure the engine computes comes with a trace saying how it was reached. Each trace line is about one figure (`line.label`), and its sentence names the figures it uses as the form prints them, so a caller shows the figure beside the sentence. This is the trace for the last Ontario line (ON428 line 90, "Ontario tax"):
+
+```text
+line 90: Line 88 (3311.45) plus line 89 (600.00) gives 3911.45 (rounded to the nearest cent).
+```
+
+## Why tax-engine
+
+- **Explains itself.** A trace for every line: inputs, operation, result, rounding. A renderer turns it into text in any language; English is built today.
+- **Mirrors the forms.** One form line is one capability, so engine steps read like the form itself.
+- **Rules are data.** Rates, thresholds and limits are datasets copied as printed, never recomputed in code.
+- **Follows the published forms.** The engine follows the CRA's published forms and formulas, including the T4127 payroll guide, line by line. It is an independent estimation tool and has not been reviewed or approved by the CRA.
+- **Exact arithmetic.** `Decimal` everywhere, rounding only where the form says to round.
+- **Jurisdiction-agnostic core.** Jurisdictions are plugins that add forms, datasets and capabilities; adding one does not change the core.
+
+## Quick start
+
+Requires Python 3.12 or newer. Install from a checkout:
+
+```sh
+git clone https://github.com/The-Pied-Piper/tax-engine.git
+cd tax-engine
+pip install -e .
+```
+
+Run the example, which prints the English trace for every form (the argument is the gross salary):
+
+```sh
+python examples/quickstart.py 70000
+```
+
+`examples/quickstart.py`:
+
+```python
+import sys
+from decimal import Decimal
+
+from tax_engine import build_tax_computation
+from tax_engine.adapters.inbound.trace_english import EnglishNames, EnglishTraceRenderer
+from tax_engine.domain.artifact import Artifact
+from tax_engine.domain.jurisdiction_code import JurisdictionCode
+from tax_engine.jurisdictions.ca.catalog.income import EMPLOYMENT_INCOME
+
+engine = build_tax_computation()
+sheets = engine.compute(
+    JurisdictionCode("CA-ON"), 2025, Artifact(EMPLOYMENT_INCOME, Decimal(sys.argv[1]))
+)
+for form, form_sheets in sheets.items():
+    for sheet in form_sheets:
+        print(f"\n== {form} ==")
+        renderer = EnglishTraceRenderer()
+        names = EnglishNames(sheet)
+        for line in sheet.trace:
+            # The sentence names the figures it uses as the form prints them when it is given
+            # the worksheet; the figure the line is about is named beside it.
+            sentence = renderer.render(line, sheet)
+            print(sentence if line.label is None else f"{names.of_label(line.label)}: {sentence}")
+```
+
+The example uses Ontario (`CA-ON`) and tax year 2025. Change `CA-ON` to `CA-AB` for Alberta, and `2025` to `2026` for the provisional 2026 year.
+
+## How it works
+
+A jurisdiction's manifest lists the forms that make up a return. Each form is built line by line from small capabilities (sum, bracket tax, credit, cap, and so on) fed by parameter datasets for the tax year. The engine wires the forms together, runs them, and records a trace for every step.
+
+## Coverage
+
+| Jurisdiction | Year | Forms and lines built |
+| --- | --- | --- |
+| Canada (federal) | 2025, 2026 (provisional) | T1 General tax lines, Schedule 8 (CPP), T2204 (EI), Schedule 6 (Canada workers benefit), taxable income |
+| Ontario | 2025, 2026 (provisional) | ON428 (Ontario tax), ON428-A (LIFT credit) |
+| Alberta | 2025, 2026 (provisional) | AB428 (Alberta tax), Worksheet AB428 (Alberta supplemental tax credit) |
+
+Roadmap: more forms and lines, and other provinces and territories. Forms are added one at a time, each built line by line from the CRA's own text.
+
+## Disclaimer and limits
+
+tax-engine is not tax advice and is not an official CRA product. It comes with no warranty, as the Apache-2.0 license says.
+
+It covers tax years 2025 and 2026 (2026 is provisional), Canada (federal), Ontario and Alberta only, and only the forms and lines listed under Coverage. A return with items the engine does not model will not come out right. The take-home example assumes a single filer with salary as the only income.
+
+Check any result against the CRA's own forms or with a professional before relying on it.
+
+## Contributing
+
+Issues and pull requests are welcome. Developer setup and checks are in [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+Licensed under the [Apache License, Version 2.0](LICENSE).

tax_engine-0.1.0/README.md

@@ -0,0 +1,115 @@
+# tax-engine: an open-source income tax calculation engine in Python
+
+[![CI](https://github.com/The-Pied-Piper/tax-engine/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/The-Pied-Piper/tax-engine/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://www.python.org/downloads/)
+
+**tax-engine is a personal income tax calculation library where every number is a line on a real tax form, and every result explains itself in a readable trace.**
+
+Tax rules live as data taken as printed from the tax authority's own forms. Each form line is one small, tested step. You can follow any figure back to the form line it came from.
+
+Supported today: Canada (federal), Ontario and Alberta, tax years 2025 and 2026 (2026 is provisional). More forms, lines, years and jurisdictions are added over time (see [Coverage](#coverage)).
+
+## Example: a $70,000 salary (tax year 2025)
+
+Given only a gross salary, the engine works out the contributions and tax from the CRA forms. Take-home is then salary minus CPP, EI and total tax, a subtraction done by the caller outside the engine:
+
+| Item | Amount |
+| --- | ---: |
+| Federal tax | 7,585.64 |
+| Ontario tax (ON428, incl. health premium) | 3,911.45 |
+| **Total tax** | **11,497.09** |
+| CPP contributions (base 3,291.75 + enhanced 665.00) | 3,956.75 |
+| EI premiums | 1,077.48 |
+| **Take-home** | **53,468.68** |
+
+Every figure the engine computes comes with a trace saying how it was reached. Each trace line is about one figure (`line.label`), and its sentence names the figures it uses as the form prints them, so a caller shows the figure beside the sentence. This is the trace for the last Ontario line (ON428 line 90, "Ontario tax"):
+
+```text
+line 90: Line 88 (3311.45) plus line 89 (600.00) gives 3911.45 (rounded to the nearest cent).
+```
+
+## Why tax-engine
+
+- **Explains itself.** A trace for every line: inputs, operation, result, rounding. A renderer turns it into text in any language; English is built today.
+- **Mirrors the forms.** One form line is one capability, so engine steps read like the form itself.
+- **Rules are data.** Rates, thresholds and limits are datasets copied as printed, never recomputed in code.
+- **Follows the published forms.** The engine follows the CRA's published forms and formulas, including the T4127 payroll guide, line by line. It is an independent estimation tool and has not been reviewed or approved by the CRA.
+- **Exact arithmetic.** `Decimal` everywhere, rounding only where the form says to round.
+- **Jurisdiction-agnostic core.** Jurisdictions are plugins that add forms, datasets and capabilities; adding one does not change the core.
+
+## Quick start
+
+Requires Python 3.12 or newer. Install from a checkout:
+
+```sh
+git clone https://github.com/The-Pied-Piper/tax-engine.git
+cd tax-engine
+pip install -e .
+```
+
+Run the example, which prints the English trace for every form (the argument is the gross salary):
+
+```sh
+python examples/quickstart.py 70000
+```
+
+`examples/quickstart.py`:
+
+```python
+import sys
+from decimal import Decimal
+
+from tax_engine import build_tax_computation
+from tax_engine.adapters.inbound.trace_english import EnglishNames, EnglishTraceRenderer
+from tax_engine.domain.artifact import Artifact
+from tax_engine.domain.jurisdiction_code import JurisdictionCode
+from tax_engine.jurisdictions.ca.catalog.income import EMPLOYMENT_INCOME
+
+engine = build_tax_computation()
+sheets = engine.compute(
+    JurisdictionCode("CA-ON"), 2025, Artifact(EMPLOYMENT_INCOME, Decimal(sys.argv[1]))
+)
+for form, form_sheets in sheets.items():
+    for sheet in form_sheets:
+        print(f"\n== {form} ==")
+        renderer = EnglishTraceRenderer()
+        names = EnglishNames(sheet)
+        for line in sheet.trace:
+            # The sentence names the figures it uses as the form prints them when it is given
+            # the worksheet; the figure the line is about is named beside it.
+            sentence = renderer.render(line, sheet)
+            print(sentence if line.label is None else f"{names.of_label(line.label)}: {sentence}")
+```
+
+The example uses Ontario (`CA-ON`) and tax year 2025. Change `CA-ON` to `CA-AB` for Alberta, and `2025` to `2026` for the provisional 2026 year.
+
+## How it works
+
+A jurisdiction's manifest lists the forms that make up a return. Each form is built line by line from small capabilities (sum, bracket tax, credit, cap, and so on) fed by parameter datasets for the tax year. The engine wires the forms together, runs them, and records a trace for every step.
+
+## Coverage
+
+| Jurisdiction | Year | Forms and lines built |
+| --- | --- | --- |
+| Canada (federal) | 2025, 2026 (provisional) | T1 General tax lines, Schedule 8 (CPP), T2204 (EI), Schedule 6 (Canada workers benefit), taxable income |
+| Ontario | 2025, 2026 (provisional) | ON428 (Ontario tax), ON428-A (LIFT credit) |
+| Alberta | 2025, 2026 (provisional) | AB428 (Alberta tax), Worksheet AB428 (Alberta supplemental tax credit) |
+
+Roadmap: more forms and lines, and other provinces and territories. Forms are added one at a time, each built line by line from the CRA's own text.
+
+## Disclaimer and limits
+
+tax-engine is not tax advice and is not an official CRA product. It comes with no warranty, as the Apache-2.0 license says.
+
+It covers tax years 2025 and 2026 (2026 is provisional), Canada (federal), Ontario and Alberta only, and only the forms and lines listed under Coverage. A return with items the engine does not model will not come out right. The take-home example assumes a single filer with salary as the only income.
+
+Check any result against the CRA's own forms or with a professional before relying on it.
+
+## Contributing
+
+Issues and pull requests are welcome. Developer setup and checks are in [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+Licensed under the [Apache License, Version 2.0](LICENSE).

tax_engine-0.1.0/pyproject.toml

@@ -0,0 +1,114 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tax-engine"
+version = "0.1.0"
+description = "Open-source personal income tax calculation engine in Python. Every number is a tax-form line, and every result explains itself in a readable trace."
+readme = "README.md"
+requires-python = ">=3.12"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Umar Khan", email = "The-Pied-Piper@users.noreply.github.com" },
+]
+keywords = [
+    "tax",
+    "income-tax",
+    "tax-calculation",
+    "canada",
+    "ontario",
+    "decimal",
+    "explainable",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Office/Business :: Financial",
+]
+dependencies = [
+    "PyYAML>=6.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "build>=1.2",
+    "import-linter>=2.0",
+    "mypy>=1.11",
+    "pytest>=8.3",
+    "ruff>=0.6",
+    "types-PyYAML",
+]
+
+[project.urls]
+Documentation = "https://github.com/The-Pied-Piper/tax-engine#readme"
+Repository = "https://github.com/The-Pied-Piper/tax-engine"
+Issues = "https://github.com/The-Pied-Piper/tax-engine/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+tax_engine = ["jurisdictions/**/*.yaml"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+
+[tool.importlinter]
+root_package = "tax_engine"
+
+[[tool.importlinter.contracts]]
+id = "layers"
+name = "Layers point inward"
+type = "layers"
+layers = [
+    "tax_engine.factory",
+    "tax_engine.registrations",
+    "tax_engine.adapters",
+    "tax_engine.application",
+    "tax_engine.domain",
+]
+
+[[tool.importlinter.contracts]]
+id = "jurisdictions"
+name = "Jurisdictions never use the application layer, wiring or outbound adapters"
+type = "forbidden"
+source_modules = ["tax_engine.jurisdictions"]
+forbidden_modules = [
+    "tax_engine.application",
+    "tax_engine.factory",
+    "tax_engine.registrations",
+    "tax_engine.adapters.outbound",
+]
+# The one exception: a jurisdiction's parameter parsers extend the parser base class and read
+# their dataset through YamlNode.
+ignore_imports = [
+    "tax_engine.jurisdictions.*.parameter_parsers.** -> tax_engine.adapters.outbound.parameter_parser",
+    "tax_engine.jurisdictions.*.parameter_parsers.** -> tax_engine.adapters.outbound.yaml_support",
+]
+
+[[tool.importlinter.contracts]]
+id = "core"
+name = "Core never imports a jurisdiction"
+type = "forbidden"
+source_modules = [
+    "tax_engine.domain",
+    "tax_engine.application",
+    "tax_engine.adapters",
+]
+forbidden_modules = ["tax_engine.jurisdictions"]

tax_engine-0.1.0/setup.cfg

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

tax_engine-0.1.0/src/tax_engine/__init__.py

@@ -0,0 +1,6 @@
+"""Tax computation engine and jurisdiction implementations."""
+
+from tax_engine.application.services.tax_computation import TaxComputationService
+from tax_engine.factory import build_tax_computation
+
+__all__ = ["TaxComputationService", "build_tax_computation"]

tax_engine-0.1.0/src/tax_engine/adapters/__init__.py

@@ -0,0 +1 @@
+"""Adapters for loading engine data and rendering computation traces."""

tax_engine-0.1.0/src/tax_engine/adapters/inbound/__init__.py

@@ -0,0 +1 @@
+"""Inbound adapters for engine-facing interfaces."""

tax_engine-0.1.0/src/tax_engine/adapters/inbound/trace_english/__init__.py

@@ -0,0 +1,45 @@
+"""English rendering of the structured trace: one readable sentence per trace line.
+
+A new module of core trace lines adds its renderer module here; a jurisdiction renders its own lines
+in its `trace_english` package.
+"""
+
+from __future__ import annotations
+
+from tax_engine.adapters.inbound.trace_english import (
+    arithmetic,
+    blank,
+    choices,
+    figures,
+    forms,
+    line_renderer,
+    names,
+    rate_tables,
+    record_lists,
+    registry,
+    renderer,
+    unit_text,
+)
+from tax_engine.adapters.inbound.trace_english.line_renderer import LineRenderer
+from tax_engine.adapters.inbound.trace_english.names import EnglishNames, FigureNames, Labelled
+from tax_engine.adapters.inbound.trace_english.renderer import EnglishTraceRenderer
+
+__all__ = [
+    "EnglishNames",
+    "EnglishTraceRenderer",
+    "FigureNames",
+    "Labelled",
+    "LineRenderer",
+    "arithmetic",
+    "blank",
+    "choices",
+    "figures",
+    "forms",
+    "line_renderer",
+    "names",
+    "rate_tables",
+    "record_lists",
+    "registry",
+    "renderer",
+    "unit_text",
+]