loan-simu 0.2.0__tar.gz

loan_simu-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Léo Guignard
+
+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.

loan_simu-0.2.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: loan-simu
+Version: 0.2.0
+Summary: Desktop simulator for French renovation loans (prêt travaux, éco-PTZ, TAEG, taux d'usure, taux d'endettement)
+Author: Léo Guignard
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/leoguignard/loan-simu
+Project-URL: Source, https://github.com/leoguignard/loan-simu
+Project-URL: Issues, https://github.com/leoguignard/loan-simu/issues
+Keywords: loan,mortgage,simulator,france,pret travaux,eco-ptz,taeg,amortization
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: X11 Applications :: Qt
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Office/Business :: Financial
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PySide6>=6.5
+Requires-Dist: matplotlib>=3.7
+Provides-Extra: dev
+Requires-Dist: bumpver; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# Renovation Loan Simulator (France)
+
+A desktop app (Qt / PySide6) to simulate a loan for renovating an apartment in France (*prêt travaux*).
+
+## Install
+
+```bash
+pip install loan-simu
+loan-simu            # or: python -m loan_simu
+```
+
+It needs Python 3.10 or later. PySide6 and matplotlib are installed with it.
+
+Numbers are shown in French format and you can type `4,5` or `4.5`. Results update as you type.
+
+The app follows the system's light or dark mode. To force one, set `LOAN_SIMU_THEME=light` or `LOAN_SIMU_THEME=dark`.
+
+## Simple mode
+
+You enter the works cost, down payment, duration, rate, insurance, your net monthly income and your other loan payments. You get:
+
+- the monthly payment, the total cost of credit and the APR (TAEG)
+- the debt ratio (*taux d'endettement*), on a gauge against the 35 % HCSF limit, and the money left each month
+- a breakdown of capital, interest and insurance
+- a table comparing durations from 3 to 25 years, with the debt ratio for each; click a row to use that duration
+
+## In-depth mode
+
+| Area | What it covers |
+|---|---|
+| Project | Works cost, down payment (*apport*), grants (MaPrimeRénov', CEE…) |
+| Main loan | Personal loan (*crédit conso*) or real-estate loan (*prêt immobilier*), rate, duration, partial or total deferral (*différé*) |
+| Insurance | Rate, based on initial or remaining capital, coverage (*quotité*) |
+| Fees | Bank fee (*frais de dossier*), guarantee (*caution* / *hypothèque*), broker fee |
+| Éco-PTZ | 0 % loan for energy renovation, with a cap and maximum duration per category |
+| Budget | Debt ratio against the 35 % HCSF limit, money left to live on (*reste à vivre*) |
+| Early repayment | Penalty (IRA), interest saved, choice between a shorter loan and a lower payment |
+| Checks | APR above the usury rate, consumer loan over 75 000 €, real-estate loan over 25 years |
+
+The in-depth mode also has an amortization table (combined or per loan, by month or by year, exported as CSV for French Excel) and charts.
+
+## Calculation rules
+
+- Monthly rate = nominal rate / 12 (*taux proportionnel*), constant monthly payments.
+- The TAEG is the actuarial rate including interest, insurance and upfront fees. It is calculated without the early repayment, as banks do.
+- IRA:
+  - real-estate loan: the lower of 6 months of interest and 3 % of the remaining capital
+  - consumer loan: 1 % of the amount repaid (0.5 % if 12 months or less remain), nothing for 10 000 € or less, capped at the remaining interest
+  - éco-PTZ: no penalty
+
+## Keep these up to date
+
+The values in [src/loan_simu/core.py](https://github.com/leoguignard/loan-simu/blob/main/src/loan_simu/core.py) change over time:
+
+- **Usury rates** (`USURY_*`) are published every quarter by the Banque de France. The real-estate table is from Q4 2026. The consumer table is from Q3 2026, because the Q4 figures were not found.
+- **Éco-PTZ caps** (`ECO_PTZ_CATEGORIES`): check them on service-public.fr (page F19905).
+
+## Development
+
+```bash
+git clone https://github.com/leoguignard/loan-simu.git
+cd loan-simu
+pip install -e ".[dev]"  # app + release tools (bumpver, build, twine)
+python -m unittest       # engine tests + offscreen UI smoke test
+```
+
+```text
+src/loan_simu/
+  core.py         calculation engine (no GUI dependency)
+  ui/
+    app.py        main window and entry point
+    simple.py     simple mode
+    advanced.py   in-depth mode
+    widgets.py    cards, number fields, debt-ratio gauge
+    charts.py     matplotlib charts
+    theme.py      light/dark palettes and stylesheet
+tests/            engine tests and an offscreen UI smoke test
+```
+
+### Releasing to PyPI
+
+1. Bump the version with [bumpver](https://github.com/mbarkhau/bumpver). It updates `pyproject.toml` and
+   `src/loan_simu/__init__.py`, then commits and tags (needs a clean working tree):
+
+   ```bash
+   bumpver update --patch --dry   # preview the change
+   bumpver update --patch         # or --minor / --major
+   git push --follow-tags
+   ```
+
+2. Build and check:
+
+   ```bash
+   rm -rf dist && python -m build
+   twine check dist/*
+   ```
+
+3. Upload to TestPyPI first, then to PyPI:
+
+   ```bash
+   twine upload --repository testpypi dist/*
+   twine upload dist/*
+   ```
+
+## Disclaimer
+
+This is a simulation, not a loan offer. Your bank's offer (*offre de prêt*) and its FISE are the documents that count.
+
+## License
+
+MIT, see [LICENSE](https://github.com/leoguignard/loan-simu/blob/main/LICENSE).

loan_simu-0.2.0/README.md

@@ -0,0 +1,111 @@
+# Renovation Loan Simulator (France)
+
+A desktop app (Qt / PySide6) to simulate a loan for renovating an apartment in France (*prêt travaux*).
+
+## Install
+
+```bash
+pip install loan-simu
+loan-simu            # or: python -m loan_simu
+```
+
+It needs Python 3.10 or later. PySide6 and matplotlib are installed with it.
+
+Numbers are shown in French format and you can type `4,5` or `4.5`. Results update as you type.
+
+The app follows the system's light or dark mode. To force one, set `LOAN_SIMU_THEME=light` or `LOAN_SIMU_THEME=dark`.
+
+## Simple mode
+
+You enter the works cost, down payment, duration, rate, insurance, your net monthly income and your other loan payments. You get:
+
+- the monthly payment, the total cost of credit and the APR (TAEG)
+- the debt ratio (*taux d'endettement*), on a gauge against the 35 % HCSF limit, and the money left each month
+- a breakdown of capital, interest and insurance
+- a table comparing durations from 3 to 25 years, with the debt ratio for each; click a row to use that duration
+
+## In-depth mode
+
+| Area | What it covers |
+|---|---|
+| Project | Works cost, down payment (*apport*), grants (MaPrimeRénov', CEE…) |
+| Main loan | Personal loan (*crédit conso*) or real-estate loan (*prêt immobilier*), rate, duration, partial or total deferral (*différé*) |
+| Insurance | Rate, based on initial or remaining capital, coverage (*quotité*) |
+| Fees | Bank fee (*frais de dossier*), guarantee (*caution* / *hypothèque*), broker fee |
+| Éco-PTZ | 0 % loan for energy renovation, with a cap and maximum duration per category |
+| Budget | Debt ratio against the 35 % HCSF limit, money left to live on (*reste à vivre*) |
+| Early repayment | Penalty (IRA), interest saved, choice between a shorter loan and a lower payment |
+| Checks | APR above the usury rate, consumer loan over 75 000 €, real-estate loan over 25 years |
+
+The in-depth mode also has an amortization table (combined or per loan, by month or by year, exported as CSV for French Excel) and charts.
+
+## Calculation rules
+
+- Monthly rate = nominal rate / 12 (*taux proportionnel*), constant monthly payments.
+- The TAEG is the actuarial rate including interest, insurance and upfront fees. It is calculated without the early repayment, as banks do.
+- IRA:
+  - real-estate loan: the lower of 6 months of interest and 3 % of the remaining capital
+  - consumer loan: 1 % of the amount repaid (0.5 % if 12 months or less remain), nothing for 10 000 € or less, capped at the remaining interest
+  - éco-PTZ: no penalty
+
+## Keep these up to date
+
+The values in [src/loan_simu/core.py](https://github.com/leoguignard/loan-simu/blob/main/src/loan_simu/core.py) change over time:
+
+- **Usury rates** (`USURY_*`) are published every quarter by the Banque de France. The real-estate table is from Q4 2026. The consumer table is from Q3 2026, because the Q4 figures were not found.
+- **Éco-PTZ caps** (`ECO_PTZ_CATEGORIES`): check them on service-public.fr (page F19905).
+
+## Development
+
+```bash
+git clone https://github.com/leoguignard/loan-simu.git
+cd loan-simu
+pip install -e ".[dev]"  # app + release tools (bumpver, build, twine)
+python -m unittest       # engine tests + offscreen UI smoke test
+```
+
+```text
+src/loan_simu/
+  core.py         calculation engine (no GUI dependency)
+  ui/
+    app.py        main window and entry point
+    simple.py     simple mode
+    advanced.py   in-depth mode
+    widgets.py    cards, number fields, debt-ratio gauge
+    charts.py     matplotlib charts
+    theme.py      light/dark palettes and stylesheet
+tests/            engine tests and an offscreen UI smoke test
+```
+
+### Releasing to PyPI
+
+1. Bump the version with [bumpver](https://github.com/mbarkhau/bumpver). It updates `pyproject.toml` and
+   `src/loan_simu/__init__.py`, then commits and tags (needs a clean working tree):
+
+   ```bash
+   bumpver update --patch --dry   # preview the change
+   bumpver update --patch         # or --minor / --major
+   git push --follow-tags
+   ```
+
+2. Build and check:
+
+   ```bash
+   rm -rf dist && python -m build
+   twine check dist/*
+   ```
+
+3. Upload to TestPyPI first, then to PyPI:
+
+   ```bash
+   twine upload --repository testpypi dist/*
+   twine upload dist/*
+   ```
+
+## Disclaimer
+
+This is a simulation, not a loan offer. Your bank's offer (*offre de prêt*) and its FISE are the documents that count.
+
+## License
+
+MIT, see [LICENSE](https://github.com/leoguignard/loan-simu/blob/main/LICENSE).

loan_simu-0.2.0/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "loan-simu"
+dynamic = ["version"]
+description = "Desktop simulator for French renovation loans (prêt travaux, éco-PTZ, TAEG, taux d'usure, taux d'endettement)"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+authors = [{ name = "Léo Guignard" }]
+keywords = ["loan", "mortgage", "simulator", "france", "pret travaux", "eco-ptz", "taeg", "amortization"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: X11 Applications :: Qt",
+    "Intended Audience :: End Users/Desktop",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Office/Business :: Financial",
+]
+dependencies = ["PySide6>=6.5", "matplotlib>=3.7"]
+
+[project.optional-dependencies]
+dev = ["bumpver", "build", "twine"]
+
+[project.urls]
+Homepage = "https://github.com/leoguignard/loan-simu"
+Source = "https://github.com/leoguignard/loan-simu"
+Issues = "https://github.com/leoguignard/loan-simu/issues"
+
+[project.gui-scripts]
+loan-simu = "loan_simu.ui.app:main"
+
+[tool.setuptools.dynamic]
+version = { attr = "loan_simu.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+
+[tool.bumpver]
+current_version = "0.2.0"
+version_pattern = "MAJOR.MINOR.PATCH"
+commit_message = "Bump version {old_version} -> {new_version}"
+commit = true
+tag = true
+push = false
+
+[tool.bumpver.file_patterns]
+"pyproject.toml" = ['current_version = "{version}"']
+"src/loan_simu/__init__.py" = ['__version__ = "{version}"']

loan_simu-0.2.0/setup.cfg

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

loan_simu-0.2.0/src/loan_simu/__init__.py

@@ -0,0 +1,3 @@
+"""Renovation loan simulator for France."""
+
+__version__ = "0.2.0"

loan_simu-0.2.0/src/loan_simu/__main__.py

@@ -0,0 +1,3 @@
+from .ui.app import main
+
+main()