Metadata-Version: 2.1
Name: Rangekeeper
Version: 0.7.1
Summary: A Python library assisting financial modelling in real estate asset & development planning, decision-making, cashflow forecasting, and scenario analysis.
License: MPL-2.0
Author: Daniel Fink
Author-email: danfink@mit.edu
Requires-Python: >=3.10,<3.13
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: aenum (>=3.1,<4.0)
Requires-Dist: matplotlib (>=3.9,<4.0)
Requires-Dist: mpld3 (>=0.5,<0.6)
Requires-Dist: multiprocess (>=0.70,<0.71)
Requires-Dist: networkx (>=3.3,<4.0)
Requires-Dist: numba (>=0.60,<0.61)
Requires-Dist: numpy-financial (>=1.0,<2.0)
Requires-Dist: pandas (>=2.2,<3.0)
Requires-Dist: pint (>=0.24,<0.25)
Requires-Dist: plotly (>=5.22,<6.0)
Requires-Dist: py-moneyed (>=3.0,<4.0)
Requires-Dist: pyarrow (>=18.1,<19.0)
Requires-Dist: pyvis (>=0.3,<0.4)
Requires-Dist: pyxirr (>=0.10,<0.11)
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: scipy (>=1.13,<2.0)
Requires-Dist: seaborn (>=0.13,<0.14)
Requires-Dist: specklepy (>=2.19,<3.0)
Requires-Dist: tabulate (>=0.9,<0.10)
Description-Content-Type: text/markdown

# 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.

