Metadata-Version: 2.1
Name: cfbd-json-py
Version: 0.0.20
Summary: Allows users to access the CFBD API, and get the resulting data in either a dictionary (think JSON), or in a pandas DataFrame (think spreadsheet).
Author-email: Joseph Armstrong <armstrongjoseph08@gmail.com>
Maintainer-email: Joseph Armstrong <armstrongjoseph08@gmail.com>
License: MIT
Project-URL: homepage, https://github.com/armstjc/cfbd-json-py
Project-URL: documentation, https://armstjc.github.io/cfbd-json-py/cfbd_json_py.html
Project-URL: repository, https://github.com/armstjc/cfbd-json-py.git
Project-URL: changelog, https://github.com/armstjc/cfbd-json-py/blob/main/CHANGELOG.md
Keywords: sports,football,college,college football
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: setuptools>=67.6.0
Requires-Dist: wheel
Requires-Dist: pyarrow>=11.0.0
Requires-Dist: pandas>=2.0.3
Requires-Dist: tqdm
Requires-Dist: requests
Requires-Dist: lxml

# cfbd-json-py
Allows users to access the CFBD API, and get the resulting data in either a dictionary (think JSON), or in a pandas DataFrame (think spreadsheet).

## How to Install

This package is is available through the `pip` package manager, and can be installed through one of the following commands in your terminal/shell:

```
pip install cfbd_json_py
```

OR

```
python -m pip install cfbd_json_py
```

If you are using a Linux/Mac instance, you may need to specify `python3` when installing.

```
python3 -m pip install cfbd_json_py
```

Alternatively, `cfbd-json-py` can be installed from this GitHub repository with the following command through pip:

```
pip install git+https://github.com/armstjc/cfbd-json-py
```

OR

```
python -m pip install git+https://github.com/armstjc/cfbd-json-py
```

OR

```
python3 -m pip install git+https://github.com/armstjc/cfbd-json-py
```

## Project Staus
You can view the status of the project [by clicking on this link](https://github.com/users/armstjc/projects/4). It will be updated periodically as more features are implemented into this python package.

## Bugs/Issues

If you find an issue/bug while using this python package, [please feel free to raise an issue](https://github.com/armstjc/cfbd-json-py/issues), we're only human, and there will inevitably be issues found!

## Docs
For the cfbd-json-py docs, they can be found at [armstjc.github.io/cfbd-json-py/](armstjc.github.io/cfbd-json-py/)
