Metadata-Version: 2.1
Name: bballRefWebScraper
Version: 0.1.0
Summary: A package that Grabs basketball data from basketball-reference
Home-page: https://github.com/michaelc143/BballRefWebScraper
Author: Michael Corbishley
Author-email: corbishleymichael1@gmail.com
Maintainer: Michael Corbishley
Maintainer-email: corbishleymichael1@gmail.com
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: beautifulsoup4 (==4.12.2)
Requires-Dist: bs4 (==0.0.1)
Requires-Dist: lxml (==4.9.3)
Requires-Dist: numpy (==1.24.3)
Requires-Dist: pandas (==2.0.3)
Requires-Dist: unidecode (==1.2.0)
Requires-Dist: requests (==2.31.0)
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

# Basketball-Reference Web Scraping Application

## Overview

* Grabs basketball data from [Basketball-Reference](https://www.basketball-reference.com/).
* Extracts player stats, game scores, team information, and more via BeautifulSoup.
* Ideal for basketball analytics, data science, and machine learning.

## Usage

### Installation

* Clone down the repository to your local machine using git clone
* Cd into the cloned repository
* Install the requirements with pip install -r requirements.txt

```bash
git clone https://github.com/michaelc143/BballRefWebScraper.git
cd BballRefWebScraper/
pip install -r requirements.txt
```

* There is also a Dockerfile built into this repository that can be used via:

```bash
docker build . -t BballRefScraper
docker run BballRefScraper
```

### Running the Application

* Example functionality can be found in the examples.py file

```bash
cd BballRefWebScraper/
python3 bball_ref_web_scraper/examples.py
```

### Packages Required

* Pandas
* BeautifulSoup
* Unidecode
* Requests
* Pytest
* Pylint
* Coverage

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
