Metadata-Version: 2.4
Name: Rangekeeper
Version: 0.7.7
Summary: A Python library assisting financial modelling in real estate asset & development planning, decision-making, cashflow forecasting, and scenario analysis.
Author-email: Daniel Fink <danfink@mit.edu>
License-Expression: MPL-2.0
Requires-Python: <3.13,>=3.10
Description-Content-Type: text/markdown
Requires-Dist: matplotlib>=3.10
Requires-Dist: pandas>=2.2
Requires-Dist: pint>=0.24
Requires-Dist: pyxirr>=0.10
Requires-Dist: scipy>=1.14
Requires-Dist: networkx>=3.3
Requires-Dist: py-moneyed>=3.0
Requires-Dist: tabulate>=0.9
Requires-Dist: specklepy>=2.21
Requires-Dist: numba>=0.61
Requires-Dist: multiprocess>=0.70
Requires-Dist: seaborn>=0.13
Requires-Dist: pyvis>=0.3
Requires-Dist: plotly>=6.0
Requires-Dist: aenum>=3.1
Requires-Dist: numpy-financial>=1.0
Requires-Dist: black>=25.1
Requires-Dist: pytest>=8.3

# Rangekeeper Source
This directory holds the source code for the Rangekeeper Library

## Installation
The library is offered through PyPI, and so its installation in other projects can be performed by:
`pip install rangekeeper` or `poetry add rangekeeper`

## Development
If you wish to contribute to its development, it is recommended to use [Poetry](https://python-poetry.org/) for environment and dependency management:

### Environment Setup

1. Install poetry, if you haven't yet: <https://python-poetry.org/docs/master/#installing-with-the-official-installer>
2. Clone this repo.
3. Use a terminal to install poetry packages from the repo's directory: `<path_to_repo>$ poetry install`
4. If you wish to develop this repo alongside other projects locally, you may install the local Rangekeeper library via `<path_to_repo>$ poetry run pip install -e <path_to_rangekeeper_repo>`,
replacing `<path_to_rangekeeper_repo>` with its location on your system.
5. Some tests require API access to [Speckle](https://speckle.systems/). It is recommended to use the [Poetry Dotenv Plugin](https://github.com/mpeteuil/poetry-dotenv-plugin) via `poetry self add poetry-dotenv-plugin`, and add a `.env` file in the project's root directory with your `SPECKLE_TOKEN` environment variable.
