Metadata-Version: 2.1
Name: pycompete
Version: 0.0.5
Summary: Tools to support the training and evalaution of models for the CrunchDAO project.
Author: Francis P Chmiel
License: MIT license
Keywords: crunchdao
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# pycompete

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)![GitHub](https://img.shields.io/github/license/FChmiel/pycompete)

pycompete provides tools to support the training and evaluation of models for the [CrunchDAO competition](https://www.crunchdao.com/).

## Installing pycompete

`pip install pycompete`

## Interacting with the CrunchDAO tournament

We recommend using the open-source [CrunchDAO Python](https://github.com/uuazed/crunchdao/tree/main) API for pulling data and submitting predictions.

To interact with the API, you need set your API key as the `CRUNCH_API_KEY` environment variable:

`export CRUNCH_API_KEY = YOUR_API_KEY`

## Contributing

Contributions are welcome! Please feel free to raise a PR adding any functionality you think may be useful to other CrunchDAO competitors. If you find a bug please raise an issue and we will try and address.
