Metadata-Version: 2.4
Name: actuarial
Version: 0.0.5
Summary: Actuarial Modeling
Project-URL: Homepage, https://jeffmaxey.github.io/actuarial/
Project-URL: Repository, https://github.com/jeffmaxey/actuarial
Project-URL: Documentation, https://jeffmaxey.github.io/actuarial/
Author-email: Jeff Maxey <jeff.maxey@proton.me>
License-File: LICENSE
Keywords: python
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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 :: Software Development :: Libraries :: Python Modules
Requires-Python: <4.0,>=3.11
Requires-Dist: asttokens>=3.0.1
Requires-Dist: black>=26.5.1
Requires-Dist: dash-ag-grid>=35.2.0
Requires-Dist: dash-iconify>=0.1.2
Requires-Dist: dash-mantine-components>=2.7.0
Requires-Dist: dash>=4.1.0
Requires-Dist: fastapi>=0.136.3
Requires-Dist: flake8>=7.3.0
Requires-Dist: flask>=3.1.3
Requires-Dist: libcst>=1.8.6
Requires-Dist: mypy>=2.1.0
Requires-Dist: myst-parser>=4.0.1
Requires-Dist: networkx>=3.4.2
Requires-Dist: numpy>=2.2.6
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: pandas-stubs>=2.3.3.260113
Requires-Dist: pandas>=2.3.3
Requires-Dist: psutil>=7.2.2
Requires-Dist: pyodbc>=5.3.0
Requires-Dist: pytest-benchmark>=5.2.3
Requires-Dist: pytest-cov>=7.1.0
Requires-Dist: pytest-coverage>=0.0
Requires-Dist: pytest>=9.0.3
Requires-Dist: quantlib>=1.42.1
Requires-Dist: ruff>=0.15.15
Requires-Dist: scipy>=1.15.3
Requires-Dist: sqlalchemy>=2.0.50
Requires-Dist: ty>=0.0.40
Requires-Dist: urllib3>=2.7.0
Description-Content-Type: text/markdown

# actuarial

[![Release](https://img.shields.io/github/v/release/jeffmaxey/actuarial)](https://img.shields.io/github/v/release/jeffmaxey/actuarial)
[![Build status](https://img.shields.io/github/actions/workflow/status/jeffmaxey/actuarial/main.yml?branch=main)](https://github.com/jeffmaxey/actuarial/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/jeffmaxey/actuarial/branch/main/graph/badge.svg)](https://codecov.io/gh/jeffmaxey/actuarial)
[![Commit activity](https://img.shields.io/github/commit-activity/m/jeffmaxey/actuarial)](https://img.shields.io/github/commit-activity/m/jeffmaxey/actuarial)
[![License](https://img.shields.io/github/license/jeffmaxey/actuarial)](https://img.shields.io/github/license/jeffmaxey/actuarial)

Actuarial Modeling

- **Github repository**: <https://github.com/jeffmaxey/actuarial/>
- **Documentation** <https://jeffmaxey.github.io/actuarial/>

## Getting started with your project

### 1. Create a New Repository

First, create a repository on GitHub with the same name as this project, and then run the following commands:

```bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:jeffmaxey/actuarial.git
git push -u origin main
```

### 2. Set Up Your Development Environment

Then, install the environment and the pre-commit hooks with

```bash
make install
```

This will also generate your `uv.lock` file

### 3. Run the pre-commit hooks

Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:

```bash
uv run pre-commit run -a
```

### 4. Commit the changes

Lastly, commit the changes made by the two steps above to your repository.

```bash
git add .
git commit -m 'Fix formatting issues'
git push origin main
```

You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs/Zensical, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/docs_tool/#deploying-to-github-pages).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).

## Releasing a new version

- Create an API Token on [PyPI](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/jeffmaxey/actuarial/settings/secrets/actions/new).
- Create a [new release](https://github.com/jeffmaxey/actuarial/releases/new) on Github.
- Create a new tag in the form `*.*.*`.

For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).

---

Repository initiated with [osprey-oss/cookiecutter-uv](https://github.com/osprey-oss/cookiecutter-uv).
