Metadata-Version: 2.2
Name: birdgame
Version: 0.0.2
Summary: Utilities to help play the Bird Game at crunchdao.com
Home-page: https://github.com/microprediction/birdgame
Author: microprediction
Author-email: peter.cotton@microprediction.com
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: requires-dist
Dynamic: summary

# birdgame

Utilities for the Bird Game at [crunchdao.com](https://crunchdao.com). Your task is to predict the dove location. 

## Install

```bash
pip install birdgame
```

## Visualize the challenge
Run [animatebirds.py](https://github.com/microprediction/birdgame/blob/main/birdgame/animation/animatebirds.py) to get a quick sense. 

![](https://github.com/microprediction/birdgame/blob/main/docs/assets/bird_animation.png)

## Tracker examples 
See [examples](https://github.com/microprediction/birdgame/tree/main/birdgame/examples). There are:

- Self-contained examples
- Examples that build on provided classes

Take your pick! 

## General Bird Game Advice 

- [Literature](https://github.com/microprediction/birdgame/blob/main/LITERATURE.md) 
- Useful Python [packages](https://github.com/microprediction/birdgame/blob/main/PACKAGES.md)

