jacoblee23 / sabrmetrics Goto Github PK

View Code? Open in Web Editor NEW

4.0 1.0 0.0 155 KB

A library of web-scraping software for popular SABRmetrics websites.

Home Page: https://pypi.org/project/SABRmetrics

License: MIT License

Python 100.00%

baseball baseball-statistics python python3 sabermetrics web-scraper sabrmetrics mlb

sabrmetrics's Introduction

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

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

sabrmetrics's People

Contributors

Stargazers

Watchers

sabrmetrics's Issues

Documentation with sphinx

Documentation with sphinx.

Scrape Razzball Player ID list

MLBAMIDs for Active MLB Players

Standings: Wild Card

Player ID Map index

>>> from sabrmetrics.sfbb.tools import PlayerIDMap
>>> playeridmap = PlayerIDMap()
>>> playeridmap.playeridmap.index
RangeIndex(start=2, stop=2867, step=1)

The index should start at 0.

Standings: Spring Training

Write content of Player ID Map Excel file

Write the content of the Player ID Map Excel file exported by the download Excel file hyperlink.

Standings: Regular Season

Make SABRmetric site data in Player ID Map accessible via object indexing (getitem magic method)

Linting with tox

Linting with pylint/flake8 and tox.

Write content of Player ID Map CSV file

Write the content of the Player ID Map Excel file exported by the PLAYERIDMAP CSV hyperlink.

Teams

https://statsapi.mlb.com/api/v1/teams/

Scrape content of Changelog web view

Write the content of the Player ID Map Excel file exported by the view Change Log on web hyperlink.

Testing with tox

Testing using pytest and tox.

Player ID Map CHANGELOG index

>>> from sabrmetrics.sfbb.tools import PlayerIDMap
>>> playeridmap = PlayerIDMap()
>>> playeridmap.changelog.index
RangeIndex(start=1, stop=567, step=1)