Metadata-Version: 2.1
Name: shapleyrouting
Version: 0.1.0
Summary: An implementation of efficient Shapley value calculation of routing problem
License: Apache-2.0
Author: Connor Sweet
Author-email: cssweet@uwaterloo.ca
Requires-Python: >=3.8, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: geopy (>=2.3.0,<3.0.0)
Requires-Dist: numpy (>=1.24.2,<2.0.0)
Requires-Dist: streamlit (>=1.20.0,<2.0.0)
Description-Content-Type: text/markdown

# Shapley-Routing

Documentation can be found [here](https://joshzwiebel.github.io/Shapley-Routing/build/html/index.html).

## Installation

:one: Install [Poetry](https://python-poetry.org/):

```bash
pip install poetry
```

If you encounter an error, try:

```bash
export PATH="/home/<user>/.local/bin:$PATH"
```

:two: Install dependencies:

```bash
poetry install
```

## Testing

### Run style check

```bash
poetry run flake8 .
poetry run black .
```

### Running unit tests

```bash
poetry run pytest -v .
```

### Running unit tests with coverage

```bash
poetry run coverage run -m pytest -v .
poetry run coverage report -m
```

## Docs

Docs can be built using the following commands:

```bash
cd docs/
poetry run make html
```

