Skip to content

Factories for randomised AFL data sets for testing purposes

License

Notifications You must be signed in to change notification settings

tipresias/candystore

Repository files navigation

candystore

build fitzRoy integration Documentation Status Maintainability Test Coverage Contributor Covenant PyPI version

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 and AFLTables. The column names are converted to snake_case for convenience.

Installation

pip3 install candystore
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:
    docker build -t candystore_tests .
  • pip3 install -r requirements.txt
  • Run tests with the script file ./scripts/tests.sh

About

Factories for randomised AFL data sets for testing purposes

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published