Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacoblee23/sabrmetrics
A library of web-scraping software for popular SABRmetrics websites.
https://github.com/jacoblee23/sabrmetrics
baseball baseball-statistics mlb python python3 sabermetrics sabrmetrics web-scraper
Last synced: about 2 months ago
JSON representation
A library of web-scraping software for popular SABRmetrics websites.
- Host: GitHub
- URL: https://github.com/jacoblee23/sabrmetrics
- Owner: JacobLee23
- License: mit
- Created: 2022-08-03T03:50:09.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-05T21:59:25.000Z (over 1 year ago)
- Last Synced: 2024-08-11T08:07:32.180Z (5 months ago)
- Topics: baseball, baseball-statistics, mlb, python, python3, sabermetrics, sabrmetrics, web-scraper
- Language: Python
- Homepage: https://pypi.org/project/SABRmetrics
- Size: 151 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://en.wikipedia.org/wiki/Sabermetrics)
> 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](https://www.britannica.com/sports/sabermetrics)
***
## Primary Features
- Easy scraping of various Internet Player ID databases
## Installation
From PyPI:
```cmd
python -m pip install sabrmetrics
```
Directly from GitHub:
```cmd
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`](https://pypi.org/project/beautifulsoup4/) ([Documentation](https://www.crummy.com/software/BeautifulSoup/bs4/doc/))
- [`lxml`](https://pypi.org/project/lxml/) ([Documentation](https://lxml.de/))
- [`numpy`](https://pypi.org/project/numpy/) ([Documentation](https://numpy.org/doc/))
- [`pandas`](https://pypi.org/project/pandas/) ([Documentation](https://pandas.pydata.org/pandas-docs/stable/))
- [`python-dateutil`](https://pypi.org/project/python-dateutil/) ([Documentation](https://dateutil.readthedocs.io/))
- [`requests`](https://pypi.org/project/requests/) ([Documentation](https://requests.readthedocs.io/))
This project uses [`pipenv`](https://pypi.org/project/pipenv/) ([Documentation](https://pipenv.pypa.io/en/latest/)) for virtual environment dependency management.
See the [Pipfile](https://github.com/JacobLee23/SABRmetrics/blob/master/Pipfile) to see a full list of package dependencies, including development dependencies.
## Testing
The tests for this project are written using [`pytest`](https://pypi.org/project/pytest) ([Documentation](https://docs.pytest.org/)).
To run the project tests, run:
```cmd
pytest sabrmetrics/tests/
```
The `pipenv` command script shorthand defined in the project [Pipfile][Pipfile] can also be used to run the project tests; run:
```cmd
pipenv pytest
```
Another `pipenv` command script shorthand is defined in the project [Pipfile][Pipfile] can be used to output an HTML test report, using [`pytest-html`](https://pypi.org/project/pytest-html) ([Documentation](https://pytest-html.readthedocs.io/)); run:
```cmd
pipenv pytest-html
```
## License
This project is license under the [MIT License][LICENSE].
## Documentation
[][Documentation]
The documentation for this project is hosted by [Read the Docs](https://readthedocs.org/): [Official Documentation][Documentation]
[Documentation]: https://sabrmetrics.readthedocs.io/en/latest/
[LICENSE]: https://github.com/JacobLee23/SABRmetrics/blob/master/LICENSE
[Pipfile]: https://github.com/JacobLee23/SABRmetrics/blob/master/Pipfile