tipresias/candystore

# candystore

![build](https://github.com/tipresias/candystore/workflows/tests/badge.svg)
[![fitzRoy integration](https://github.com/tipresias/candystore/actions/workflows/integration.yml/badge.svg)](https://github.com/tipresias/candystore/actions/workflows/integration.yml)
[![Documentation Status](https://readthedocs.org/projects/candystore/badge/?version=latest)](https://candystore.readthedocs.io/en/latest/?badge=latest)
[![Maintainability](https://api.codeclimate.com/v1/badges/6efe0c54b8ac8682b719/maintainability)](https://codeclimate.com/github/tipresias/candystore/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/6efe0c54b8ac8682b719/test_coverage)](https://codeclimate.com/github/tipresias/candystore/test_coverage)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)
[![PyPI version](https://badge.fury.io/py/candystore.svg)](https://badge.fury.io/py/candystore)

Factories for randomised AFL data sets, selling candy to your unit tests.

The shape and content of the data is based on what's returned by the R package `fitzRoy`, which gets most of its data from the sites [Footywire](https://www.footywire.com/) and [AFLTables](https://afltables.com/afl/afl_index.html). The column names are converted to `snake_case` for convenience.

## Installation

```bash
pip3 install candystore
```

```python
from candystore import CandyStore

candy = CandyStore()
candy.fixtures()
```

## Documentation

More-detailed documentation can be found at https://candystore.readthedocs.io/en/latest/

## Setting up dev environment

- Install Docker
- Build Docker image for integration tests:
  ```bash
  docker build -t candystore_tests .
  ```
- ```bash
  pip3 install -r requirements.txt
  ```
- Run tests with the script file `./scripts/tests.sh`