actuarialpy 0.1.0__tar.gz

actuarialpy-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Michael Bryant
+
+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.

actuarialpy-0.1.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: actuarialpy
+Version: 0.1.0
+Summary: Python tools for actuarial analysis.
+Project-URL: Homepage, https://github.com/actuarialpy/actuarialpy-core
+Project-URL: Repository, https://github.com/actuarialpy/actuarialpy-core
+Project-URL: Issues, https://github.com/actuarialpy/actuarialpy-core/issues
+Author: Michael Bryant
+License-Expression: MIT
+License-File: LICENSE
+Keywords: actuarial,analytics,insurance,loss ratio,risk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.9
+Requires-Dist: numpy>=1.23
+Description-Content-Type: text/markdown
+
+# ActuarialPy
+
+**ActuarialPy** is a Python package for general actuarial analysis.
+
+The initial version includes a basic loss ratio calculation. Future modules may include experience summaries, trend tools, actual-to-expected analysis, exposure-based metrics, validation, and reporting.
+
+## Installation
+
+```bash
+pip install actuarialpy
+```
+
+## Usage
+
+```python
+from actuarialpy import loss_ratio
+
+lr = loss_ratio(expenses=850_000, revenue=1_000_000)
+
+print(lr)
+# 0.85
+```
+
+## Loss ratio
+
+```python
+loss_ratio(expenses, revenue)
+```
+
+Calculates:
+
+```text
+loss ratio = expenses / revenue
+```
+
+Examples of use:
+
+- health MLR: claims / premium
+- P&C loss ratio: losses / earned premium
+- combined-style ratios: losses plus expenses / revenue, if expenses are pre-summed before calling the function
+
+## Development
+
+Install locally in editable mode:
+
+```bash
+pip install -e .
+```
+
+Run tests:
+
+```bash
+pip install pytest
+pytest
+```
+
+Build for PyPI:
+
+```bash
+python -m pip install --upgrade build twine
+python -m build
+twine check dist/*
+twine upload dist/*
+```

actuarialpy-0.1.0/README.md

@@ -0,0 +1,64 @@
+# ActuarialPy
+
+**ActuarialPy** is a Python package for general actuarial analysis.
+
+The initial version includes a basic loss ratio calculation. Future modules may include experience summaries, trend tools, actual-to-expected analysis, exposure-based metrics, validation, and reporting.
+
+## Installation
+
+```bash
+pip install actuarialpy
+```
+
+## Usage
+
+```python
+from actuarialpy import loss_ratio
+
+lr = loss_ratio(expenses=850_000, revenue=1_000_000)
+
+print(lr)
+# 0.85
+```
+
+## Loss ratio
+
+```python
+loss_ratio(expenses, revenue)
+```
+
+Calculates:
+
+```text
+loss ratio = expenses / revenue
+```
+
+Examples of use:
+
+- health MLR: claims / premium
+- P&C loss ratio: losses / earned premium
+- combined-style ratios: losses plus expenses / revenue, if expenses are pre-summed before calling the function
+
+## Development
+
+Install locally in editable mode:
+
+```bash
+pip install -e .
+```
+
+Run tests:
+
+```bash
+pip install pytest
+pytest
+```
+
+Build for PyPI:
+
+```bash
+python -m pip install --upgrade build twine
+python -m build
+twine check dist/*
+twine upload dist/*
+```

actuarialpy-0.1.0/actuarialpy/__init__.py

@@ -0,0 +1,7 @@
+"""ActuarialPy: Python tools for actuarial analysis."""
+
+from actuarialpy.metrics import loss_ratio, safe_divide
+
+__all__ = ["loss_ratio", "safe_divide"]
+
+__version__ = "0.1.0"

actuarialpy-0.1.0/actuarialpy/metrics.py

@@ -0,0 +1,71 @@
+"""Core actuarial metrics."""
+
+from __future__ import annotations
+
+from numbers import Number
+from typing import Any
+
+import numpy as np
+
+
+def safe_divide(numerator: Any, denominator: Any) -> Any:
+    """Safely divide numerator by denominator.
+
+    Returns ``np.nan`` where the denominator is zero.
+
+    Parameters
+    ----------
+    numerator:
+        Scalar or array-like numerator.
+    denominator:
+        Scalar or array-like denominator.
+
+    Returns
+    -------
+    Any
+        Division result. Scalars return scalars; array-like inputs return NumPy arrays.
+
+    Examples
+    --------
+    >>> safe_divide(10, 2)
+    5.0
+    >>> np.isnan(safe_divide(10, 0))
+    True
+    """
+    if isinstance(numerator, Number) and isinstance(denominator, Number):
+        return np.nan if denominator == 0 else numerator / denominator
+
+    numerator_arr = np.asarray(numerator, dtype=float)
+    denominator_arr = np.asarray(denominator, dtype=float)
+
+    return np.divide(
+        numerator_arr,
+        denominator_arr,
+        out=np.full_like(numerator_arr, np.nan, dtype=float),
+        where=denominator_arr != 0,
+    )
+
+
+def loss_ratio(expenses: Any, revenue: Any) -> Any:
+    """Calculate a loss ratio.
+
+    The loss ratio is defined generally as expenses divided by revenue.
+
+    Parameters
+    ----------
+    expenses:
+        Claims, losses, benefits, or other expense amount.
+    revenue:
+        Premium, earned premium, revenue, or other denominator amount.
+
+    Returns
+    -------
+    Any
+        Loss ratio as a decimal.
+
+    Examples
+    --------
+    >>> loss_ratio(850_000, 1_000_000)
+    0.85
+    """
+    return safe_divide(expenses, revenue)

actuarialpy-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "actuarialpy"
+version = "0.1.0"
+description = "Python tools for actuarial analysis."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [
+    { name = "Michael Bryant" }
+]
+keywords = [
+    "actuarial",
+    "insurance",
+    "loss ratio",
+    "risk",
+    "analytics"
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Financial and Insurance Industry",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Office/Business :: Financial",
+    "Topic :: Scientific/Engineering :: Mathematics"
+]
+dependencies = [
+    "numpy>=1.23"
+]
+
+[project.urls]
+Homepage = "https://github.com/actuarialpy/actuarialpy-core"
+Repository = "https://github.com/actuarialpy/actuarialpy-core"
+Issues = "https://github.com/actuarialpy/actuarialpy-core/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["actuarialpy"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

actuarialpy-0.1.0/tests/test_metrics.py

@@ -0,0 +1,23 @@
+import numpy as np
+
+from actuarialpy import loss_ratio, safe_divide
+
+
+def test_safe_divide_scalar():
+    assert safe_divide(10, 2) == 5
+
+
+def test_safe_divide_zero_denominator():
+    assert np.isnan(safe_divide(10, 0))
+
+
+def test_loss_ratio_scalar():
+    assert loss_ratio(850_000, 1_000_000) == 0.85
+
+
+def test_loss_ratio_array():
+    result = loss_ratio([50, 80, 100], [100, 100, 0])
+
+    assert result[0] == 0.5
+    assert result[1] == 0.8
+    assert np.isnan(result[2])