Code refactoring

Author: andrewmurphy353

.gitignore

@@ -5,6 +5,7 @@ __pycache__/
 .pytest_cache/
 build/
 dist/
+site/
 wheels/
 *.egg-info
 

CHANGELOG.md

@@ -1,5 +1,17 @@
-# History
+## [1.0.0-rc1] - 2026-01-09
 
-## 0.1.0 (2025-12-22)
+Initial release candidate of Curo Python, providing instalment credit calculations aligned with Curo Dart (`2.4.3`) core functionality.
 
-* First release on PyPI.
+### Added
+- `Calculator` class for solving cash flow values and rates using Brent's method.
+- Daycount conventions: `US30360`, `Actual360`, `EU200848EC`, and others.
+- Series classes: `SeriesAdvance`, `SeriesPayment`, `SeriesCharge`.
+- Enums: `Mode`, `Frequency`, `DayCountTimePeriod`.
+- Exceptions: `UnsolvableError`, `ValidationError`.
+- MkDocs documentation with `doctest`-verified examples.
+
+### Notes
+- Feedback welcome on [GitHub](https://github.com/andrewmurphy353/curo_python) for `1.0.0`.
+- Targeting feature parity with Curo Dart `2.4.3`.
+
+Install with `pip install curo==1.0.0-rc1`.

MANIFEST.in

@@ -2,10 +2,7 @@ include CHANGELOG.md
 include LICENSE
 include README.md
 
-recursive-include assets/images *
-recursive-include examples *.py
+recursive-include docs *.md *.py *.png *.pdf
 recursive-include tests *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
-
-recursive-include docs *.md Makefile *.jpg *.png *.gif

Makefile

@@ -12,7 +12,8 @@
 
 # Configuration
 PYTHON := python3.11
-DOCTEST_FILES := $(wildcard curo/daycount/*.py curo/calculator.py)
+#DOCTEST_FILES := $(wildcard curo/daycount/*.py docs/examples/*.md curo/calculator.py)
+DOCTEST_FILES := $(wildcard docs/tests/example_01.py)
 VENV_DIR := .venv
 UV := uv
 
@@ -128,7 +129,7 @@ clean-venv:
 # Clean build artifacts
 .PHONY: clean-build
 clean-build:
-	rm -rf dist/ build/ coverage_html/
+	rm -rf build/ coverage_html/ dist/ site/
 
 # Rebuild virtual environment
 .PHONY: rebuild-venv
@@ -137,11 +138,11 @@ rebuild-venv: clean
 	$(UV) pip install ".[dev]" -e .
 	$(UV) lock
 
-.PHONY: serve-docs
-serve-docs:
+.PHONY: mkdocs-serve
+mkdocs-serve:
 	$(UV) run mkdocs serve
 
 # Deploy docs to GitHub pages
-.PHONY: deploy-docs
-deploy-docs:
+.PHONY: mkdocs-deploy
+mkdocs-deploy:
 	$(UV) run mkdocs gh-deploy

README.md

@@ -17,7 +17,7 @@ Curo Python is designed for developers and financial professionals who need robu
 - Support for multiple day count conventions, including EU and US regulatory standards.
 - Flexible handling of cash flow series for loans, leases, and investment scenarios.
 
-Check out the [examples folder](https://github.com/andrewmurphy353/curo_python/tree/main/examples) for practical use cases and accompanying cash flow diagrams that visualize inflows and outflows.
+Check out the [examples folder](https://github.com/andrewmurphy353/curo_python/tree/main/examples) for practical use cases and accompanying cash flow diagrams that visualise inflows and outflows.
 
 ## Getting Started
 

curo/__init__.py

@@ -1,24 +1,52 @@
 """
-Curo - a feature-rich library for performing simple to advanced 
-instalment credit financial calculations.
+Curo Python is a powerful, open-source library for performing instalment credit
+financial calculations, from simple loans to complex leasing and hire purchase
+agreements. Built from the ground up in Python, it leverages pandas DataFrames
+for cash flow management and SciPy for efficient solving of unknown values or
+rates using Brent's method.
 """
 
 __author__ = "Andrew Murphy"
 __email__ = "curocalculator@gmail.com"
+import importlib.metadata
+__version__ = importlib.metadata.version("curo")
 
-# Declare top-level shortcuts
-# from calculator import Calculator
-# from daycount.us_30_360 import US30360
-# from daycount.us_30u_360 import US30U360
-# from daycount.us_appendix_j import USAppendixJ
-# from series import SeriesAdvance, SeriesPayment, SeriesCharge
+# Expose public API classes and enums
+from .calculator import Calculator
+from .daycount.actual_360 import Actual360
+from .daycount.actual_365 import Actual365
+from .daycount.actual_isda import ActualISDA
+from .daycount.day_count_factor import DayCountFactor
+from .daycount.eu_30_360 import EU30360
+from .daycount.eu_2008_48 import EU200848EC
+from .daycount.uk_conc_app import UKConcApp
+from .daycount.us_30_360 import US30360
+from .daycount.us_30u_360 import US30U360
+from .daycount.us_appendix_j import USAppendixJ
+from .enums import DayCountTimePeriod, Frequency, Mode
+from .exceptions import UnsolvableError, ValidationError
+from .series import SeriesAdvance, SeriesPayment, SeriesCharge
 
-# __all__ = [
-#     "Calculator",
-#     "US30360",
-#     "US30U360",
-#     "USAppendixJ",
-#     "SeriesAdvance",
-#     "SeriesPayment",
-#     "SeriesCharge",
-# ]
+# Define what gets exported with `from curo import *`
+__all__ = [
+    "Calculator",
+    "Actual360",
+    "Actual365",
+    "ActualISDA",
+    "DayCountFactor",
+    "EU30360",
+    "EU200848EC",
+    "UKConcApp",
+    "US30360",
+    "US30U360",
+    "USAppendixJ",
+    "DayCountTimePeriod",
+    "Frequency",
+    "Mode",
+    "UnsolvableError",
+    "ValidationError",
+    "SeriesAdvance",
+    "SeriesPayment",
+    "SeriesCharge",
+    "__version__",
+]

curo/calculator.py

@@ -2,13 +2,14 @@
 calculator.py
 
 This module provides the Calculator class for performing financial calculations on cash flow series,
-including solving for effective interest rates and unknown cash flow amounts. It supports various day
-count conventions (e.g., US30360, USAppendixJ) and aligns with the Dart library for accuracy in loan
-amortization and APR calculations.
+including solving for effective interest rates and unknown cash flow amounts. It supports various
+day count conventions (e.g., US30360, USAppendixJ) and aligns with the Dart library for accuracy 
+in loan amortization and APR calculations.
 
 Key Features:
 - Solves for interest rates (`solve_rate`) to achieve a net future value (NFV) of zero.
-- Solves for one or more unknown payment or advance amounts (`solve_value`) with weighted adjustments.
+- Solves for one or more unknown payment or advance amounts (`solve_value`) 
+    with weighted adjustments.
 - Supports bespoke cash flow profiles (DataFrame) or series-based profiles (Series objects).
 - Handles USAppendixJ periodic rate conversions and interest amortization.
 - Provides precise, unrounded calculations with optional rounding to specified precision.

curo/enums.py

@@ -92,7 +92,8 @@ def periods_in_year(self) -> int:
 
 class DayCountOrigin(Enum):
     """
-    Enum specifying the start date for calculating day counts in financial time periods.
+    Enum used internally to define the start date for calculating day counts
+    in financial time periods.
 
     Attributes:
         DRAWDOWN: The initial drawdown post date, used in APR and XIRR calculations.

curo/utils.py

@@ -1,5 +1,6 @@
 """
-Utility functions for date manipulation and numerical rounding in financial calculations.
+Utility functions used internally for date manipulation and numerical 
+rounding in financial calculations.
 """
 
 from typing import Union, Optional