Metadata-Version: 2.1
Name: cflapi
Version: 1.0.2
Summary: Canadian Football League API Wrapper
Home-page: https://github.com/streibeb/cflapi
Author: Brayden Streibel
Author-email: brayden@streibel.ca
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: requests

# CFLApi - a Python client for The Canadian Football League statistics API

## Description

CFLApi is a lightweight client library for the CFL statistics API

## Documentation

- [Official API Documentation](http://api.cfl.ca/docs)

## Installation

TODO

## Dependencies

- [Requests](https://github.com/kennethreitz/requests)

## API Key
You will need an API key to access the CFL API. To obtain a key, submit a [API key request](http://api.cfl.ca/key-request)

## Example

```python
import cflapi
api = cflapi.CFLApi(YOUR API KEY HERE)

response = api.getGamesBySeason(2018, filter={'team': {'eq': 'SSK'}})
for game in response['data']:
    print(game['date_start'], game['team_1']['nickname'], '@', game['team_2']['nickname'])
```

## Support
If you find an bug, have any questions or have suggestions for improvements then feel free to file an issue on the Github project page [here](https://github.com/streibeb/cflapi/issues).


