SABRmetrics

Background

An open-source library of web-scraping software for popular SABRmetrics websites.

Sabermetrics (or originally as SABRmetrics) is the empirical analysis of baseball, especially baseball statistics that measure in-game activity.

-- Wikipedia

sabermetrics, the statistical analysis of baseball data. Sabermetrics aims to quantify baseball players’ performances based on objective statistical measurements, especially in opposition to many of the established statistics (such as, for example, runs batted in and pitching wins) that give less accurate approximations of individual efficacy.

-- Britannica

Primary Features

• Easy scraping of various Internet Player ID databases

Installation

From PyPI:

python -m pip install sabrmetrics

Directly from GitHub:

python -m pip install -e git+https://github.com/JacobLee23/SABRmetrics.git#egg=sabrmetrics

Requirements

This project requires Python 3.6+.

Note: Some of the packages listed in the project Pipfile under dev-packages are not compatible with Python 3.6. This includes pytest, so project tests cannot be run using Python 3.6. However, all primary dependencies (under default) are compatible with Python 3.6, so Python 3.6 supports most normal functionality.

Dependencies

• beautifulsoup4 (Documentation)
• lxml (Documentation)
• numpy (Documentation)
• pandas (Documentation)
• python-dateutil (Documentation)
• requests (Documentation)

This project uses pipenv (Documentation) for virtual environment dependency management. See the Pipfile to see a full list of package dependencies, including development dependencies.

Testing

The tests for this project are written using pytest (Documentation). To run the project tests, run:

pytest sabrmetrics/tests/

The pipenv command script shorthand defined in the project Pipfile can also be used to run the project tests; run:

pipenv pytest

Another pipenv command script shorthand is defined in the project Pipfile can be used to output an HTML test report, using pytest-html (Documentation); run:

pipenv pytest-html

License

This project is license under the MIT License.

Documentation

The documentation for this project is hosted by Read the Docs: Official Documentation