repaykit 1.0.0__tar.gz

repaykit-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install package
+        run: python -m pip install -e ".[dev]"
+      - name: Ruff
+        run: python -m ruff check .
+      - name: Mypy
+        run: python -m mypy repaykit
+      - name: Pytest
+        run: python -m pytest --cov=repaykit --cov-report=term-missing
+      - name: Build
+        run: python -m build
+      - name: Twine check
+        run: python -m twine check dist/*

repaykit-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+      - name: Install build tools
+        run: python -m pip install build twine
+      - name: Build package
+        run: python -m build
+      - name: Check distribution metadata
+        run: python -m twine check dist/*
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

repaykit-1.0.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.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
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# 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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

repaykit-1.0.0/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+Keep a Changelog, and the project uses Semantic Versioning.
+
+## [1.0.0] - 2026-05-26
+
+### Added
+
+- Stable public API for `Loan`, `LoanAccount`, result objects, schedules, accruals, methods,
+  policies, ledger objects, and exporters.
+- Flat rate repayment schedules.
+- Sum-of-digits / Rule of 78 repayment schedules.
+- Reducing balance repayment schedules.
+- Constant principal repayment schedules.
+- Daily, weekly, biweekly, monthly, quarterly, yearly, and custom schedules.
+- Payment ledger with aggregate oldest-due-first statement allocation.
+- Configurable late charge policy.
+- Settlement quote generation with method-specific unearned profit rebate behavior.
+- Explicit rounding policy for money and rates.
+- Dict and CSV export helpers that serialize `Decimal` as strings and dates as ISO strings.
+- Type hints and `py.typed` marker.
+- PyPI packaging with Hatchling.
+- CI workflow for Ruff, mypy, pytest with coverage, build, and Twine checks.
+- PyPI Trusted Publishing release workflow.
+
+### Changed
+
+- Hardened public validation for Decimal money/rate inputs and payment dates.
+- Single-sourced package version from `repaykit.__version__`.
+
+### Fixed
+
+- Flat-rate rows now keep `installment == principal + profit` while final rows absorb rounding
+  drift.
+
+### Security
+
+- Added security reporting policy and release hygiene documentation.

repaykit-1.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,8 @@
+# Code of Conduct
+
+This project is intended to be a professional, respectful space for maintainers and contributors.
+
+Be kind, direct, and constructive. Harassment, discrimination, personal attacks, and bad-faith
+conduct are not acceptable.
+
+Report conduct concerns privately to the maintainers through the repository contact channels.

repaykit-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+Thank you for helping improve `repaykit`.
+
+## Development
+
+```bash
+python -m pip install -e ".[dev]"
+python -m ruff check .
+python -m mypy repaykit
+python -m pytest --cov=repaykit --cov-report=term-missing
+python -m build
+python -m twine check dist/*
+```
+
+Use `Decimal` for all money and rates. Do not introduce framework dependencies into the core
+package.
+
+## Calculation Changes
+
+Calculation changes need tests that cover exact expected values where the result is contractual,
+and invariant tests where exact pennies are policy-dependent. Document any new business rule as a
+policy choice rather than a legal or regulatory assumption.
+
+## Public API
+
+After 1.0.0, breaking public API changes require a major version bump.

repaykit-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 finsure techlab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

repaykit-1.0.0/PKG-INFO

@@ -0,0 +1,285 @@
+Metadata-Version: 2.4
+Name: repaykit
+Version: 1.0.0
+Summary: Pure Python repayment schedule, financing, loan ledger, and settlement calculation toolkit.
+Project-URL: Homepage, https://github.com/finsure-techlab/repaykit
+Project-URL: Repository, https://github.com/finsure-techlab/repaykit
+Project-URL: Issues, https://github.com/finsure-techlab/repaykit/issues
+Author: finsure techlab
+License-Expression: MIT
+License-File: LICENSE
+Keywords: amortization,financing,ledger,loan,repayment,settlement
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: coverage; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# repaykit
+
+Pure Python repayment schedule, financing, loan ledger, and settlement calculation toolkit.
+
+`repaykit` helps software teams calculate loan and financing schedules, payment ledgers, late
+charges, statement balances, and settlement quotes. It is framework-agnostic, uses `Decimal` for
+money and rates, and keeps business rules policy-driven.
+
+## What It Is Not
+
+`repaykit` is not a loan origination system, accounting system, regulatory compliance engine, or
+legal opinion. It does not provide legal, accounting, tax, Shariah, regulatory, lending, or
+financial advice. Users are responsible for validating calculations, policies, disclosures, and
+compliance requirements for their jurisdiction and product.
+
+## Installation
+
+```bash
+pip install repaykit
+```
+
+## Supported Methods
+
+- Flat rate
+- Sum-of-digits / Rule of 78
+- Reducing balance amortization
+- Constant principal repayment
+
+## Supported Schedules
+
+- Daily, with optional weekend skipping
+- Weekly
+- Biweekly
+- Monthly, with month-end safety
+- Quarterly
+- Yearly
+- Custom explicit due dates
+
+## Quickstart
+
+```python
+from datetime import date
+from decimal import Decimal
+
+from repaykit import Loan
+
+loan = Loan.create(
+    amount=Decimal("10000.00"),
+    annual_rate=Decimal("0.08"),
+    term="24 months",
+    payment_frequency="monthly",
+    method="flat_rate",
+    start_date=date(2026, 6, 1),
+)
+
+payment = loan.payment_amount()
+rows = loan.schedule()
+```
+
+Use `iter_schedule()` for lazy row generation, especially for daily schedules.
+
+## Expert Mode
+
+```python
+from datetime import date
+from decimal import Decimal
+
+from repaykit import Loan
+from repaykit.accruals import FlatAccrual
+from repaykit.methods import FlatRateAllocation
+from repaykit.policies import RoundingPolicy
+from repaykit.schedules import MonthlySchedule
+from repaykit.terms import Term
+
+loan = Loan(
+    principal=Decimal("10000.00"),
+    term=Term(months=24),
+    payment_schedule=MonthlySchedule(day=1),
+    accrual_policy=FlatAccrual(annual_rate=Decimal("0.08")),
+    repayment_method=FlatRateAllocation(),
+    rounding=RoundingPolicy(currency="MYR"),
+    start_date=date(2026, 6, 1),
+)
+```
+
+## Flat Rate Example
+
+```python
+loan = Loan.create(
+    amount=Decimal("10000.00"),
+    annual_rate=Decimal("0.08"),
+    term="24 months",
+    payment_frequency="monthly",
+    method="flat_rate",
+    start_date=date(2026, 6, 1),
+)
+```
+
+Flat-rate total profit is `principal * annual_rate * term_in_years`. Future scheduled profit is
+treated as unearned profit rebate in the default settlement policy.
+
+## Sum-of-Digits / Rule of 78 Example
+
+```python
+loan = Loan.create(
+    amount=Decimal("10000.00"),
+    annual_rate=Decimal("0.08"),
+    term="12 months",
+    payment_frequency="monthly",
+    method="sum_of_digits",
+    start_date=date(2026, 1, 1),
+)
+```
+
+The denominator is generalized as `n * (n + 1) / 2`, so the method works with non-monthly period
+counts such as 52 weekly periods.
+
+## Reducing Balance Example
+
+```python
+loan = Loan.create(
+    amount=Decimal("10000.00"),
+    annual_rate=Decimal("0.08"),
+    term="24 months",
+    payment_frequency="monthly",
+    method="reducing_balance",
+    start_date=date(2026, 6, 1),
+)
+```
+
+Reducing balance uses fixed-payment amortization. Profit is calculated on the outstanding balance
+for each period.
+
+## Constant Principal Example
+
+```python
+loan = Loan.create(
+    amount=Decimal("10000.00"),
+    annual_rate=Decimal("0.08"),
+    term="24 months",
+    payment_frequency="monthly",
+    method="constant_principal",
+    start_date=date(2026, 6, 1),
+)
+```
+
+The principal component is constant except for the final rounding adjustment; installments decline
+as profit declines.
+
+## Weekly Payment Example
+
+```python
+loan = Loan.create(
+    amount=Decimal("5000.00"),
+    annual_rate=Decimal("0.10"),
+    term="52 weeks",
+    payment_frequency="weekly",
+    method="constant_principal",
+    start_date=date(2026, 1, 1),
+)
+```
+
+## Daily Payment Example
+
+```python
+loan = Loan.create(
+    amount=Decimal("1000.00"),
+    annual_rate=Decimal("0.12"),
+    term="30 days",
+    payment_frequency="daily",
+    method="reducing_balance",
+    start_date=date(2026, 1, 1),
+)
+```
+
+## Payment Ledger Example
+
+```python
+from repaykit import LoanAccount
+
+account = LoanAccount(loan)
+account.add_payment(
+    amount=Decimal("500.00"),
+    paid_at=date(2026, 7, 5),
+    reference="ANGKASA-JULY-2026",
+)
+
+statement = account.statement(as_of=date(2026, 8, 1))
+print(statement.total_due)
+print(statement.total_paid)
+print(statement.arrears)
+print(statement.outstanding_balance)
+```
+
+Statements use aggregate oldest-due-first allocation for due installments and late-charge exposure.
+They do not maintain a double-entry accounting ledger or split each payment into principal/profit
+transactions.
+
+## Late Charge Example
+
+```python
+from repaykit.policies import LateChargePolicy
+
+loan.late_charge_policy = LateChargePolicy(
+    rate=Decimal("0.01"),
+    grace_days=5,
+    basis="flat",
+    minimum_charge=Decimal("0.00"),
+)
+```
+
+Supported bases are `flat` and `daily`. Negative overdue amounts are treated as zero.
+
+## Settlement Example
+
+```python
+settlement = account.full_settlement(as_of=date(2026, 12, 15))
+
+print(settlement.outstanding_principal)
+print(settlement.unearned_profit_rebate)
+print(settlement.late_charges)
+print(settlement.amount_payable)
+print(settlement.explanation)
+```
+
+Settlement is policy-based. Flat-rate and sum-of-digits methods rebate future scheduled profit by
+default. Reducing-balance and constant-principal methods have no unearned profit rebate by default.
+Validate settlement behavior against your contract and regulatory requirements.
+
+## Export Example
+
+```python
+from repaykit.exporters import schedule_to_csv, schedule_to_dicts
+
+rows = loan.schedule()
+data = schedule_to_dicts(rows)
+schedule_to_csv(rows, "schedule.csv")
+```
+
+Exporters serialize `Decimal` values as strings and dates as ISO strings. They never convert money
+to floats.
+
+## Rounding Warning
+
+The default `RoundingPolicy` uses half-up money rounding with two decimal places. Different
+institutions and jurisdictions may require different rounding points, decimal places, or settlement
+rebate rules. Configure and test policies against the governing contract and regulation.
+
+## Release Status
+
+Version 1.0.0 declares the public API documented in `docs/api.md`. Breaking public API changes
+after 1.0.0 require a major version bump.