Installation¶

Quick Install¶

Install the package from PyPI:

pip install fundedness

The package has several optional dependency groups:

For the interactive web interface:

pip install fundedness[streamlit]

For the REST API:

pip install fundedness[api]

For building documentation locally:

pip install fundedness[docs]

For development and testing:

pip install fundedness[dev]

Install everything:

pip install fundedness[all]

Clone the repository and install in editable mode:

git clone https://github.com/engineerinvestor/financial-health-calculator.git
cd financial-health-calculator
pip install -e ".[dev]"

After installation, verify it works:

from fundedness import compute_cefr
print("Installation successful!")