brlib 0.2.0__tar.gz → 0.4.0__tar.gz

brlib-0.4.0/.github/workflows/full-test.yml

@@ -0,0 +1,47 @@
+name: Full Tests
+
+on:
+  # to be run before releases
+  workflow_dispatch:
+
+jobs:
+  pytest:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        resolution: ['highest']
+        include:
+          - os: ubuntu-latest
+            python-version: "3.10"
+            resolution: 'lowest-direct'
+          - os: windows-latest
+            python-version: "3.10"
+            resolution: 'lowest-direct'
+          - os: macos-latest
+            # there's no 3.10 wheel for lxml on ARM64 macOS
+            python-version: "3.11"
+            resolution: 'lowest-direct'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Create virtual environment
+        run: uv venv
+
+      - name: Install brlib
+        run: uv pip install --resolution ${{ matrix.resolution }} -e .[dev]
+
+      - name: Run pytest
+        run: uv run pytest

{brlib-0.2.0 → brlib-0.4.0}/.github/workflows/publish.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version: "3.x"
+          python-version: "3.14"
 
       - name: Install pypa/build
         run: python3 -m pip install build --user
@@ -25,7 +25,7 @@ jobs:
         run: python3 -m build
 
       - name: Store the distribution packages
-        uses: actions/upload-artifact@v5
+        uses: actions/upload-artifact@v6
         with:
           name: python-package-distributions
           path: dist/
@@ -41,10 +41,10 @@ jobs:
       id-token: write
 
     steps:
-    - name: Download the dists
-      uses: actions/download-artifact@v6
-      with:
-        name: python-package-distributions
-        path: dist/
-    - name: Publish distribution
-      uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Download the dists
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution
+        uses: pypa/gh-action-pypi-publish@release/v1

brlib-0.4.0/.github/workflows/test.yml

@@ -0,0 +1,49 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - '**'
+  schedule:
+    # run at 12 UTC, hopefully after BR's daily in-season updates
+    # run weekly, because anything more would be overkill
+    - cron: '0 12 * * 6'
+
+jobs:
+  pytest:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.10", "3.14"]
+        exclude:
+          - os: windows-latest
+            python-version: "3.10"
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Create virtual environment
+        run: uv venv
+
+      - name: Install brlib
+        run: uv pip install --resolution highest -e .[dev]
+
+      - name: Check import sorting with isort
+        run: uv run isort --check-only .
+
+      - name: Check formatting with Black
+        run: uv run black --check .
+
+      - name: Run pytest
+        run: uv run pytest

brlib-0.4.0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: brlib
+Version: 0.4.0
+Summary: A library for collecting baseball statistics from Baseball Reference
+Project-URL: Documentation, https://github.com/john-bieren/brlib/wiki
+Project-URL: GitHub, https://github.com/john-bieren/brlib
+Project-URL: Issues, https://github.com/john-bieren/brlib/issues
+Project-URL: Release Notes, https://github.com/john-bieren/brlib/releases
+Author-email: John Bieren <jbieren64@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Keywords: baseball,baseball reference,baseball stats,mlb,mlb stats
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4<4.15.0,>=4.12.0
+Requires-Dist: curl-cffi<0.15.0,>=0.11.1
+Requires-Dist: lxml<7.0.0,>=5.0.0
+Requires-Dist: pandas<3.0.0,>=2.2.0
+Requires-Dist: platformdirs<5.0.0,>=4.0.0
+Requires-Dist: tqdm<5.0.0,>=4.66.0
+Provides-Extra: dev
+Requires-Dist: black==26.3.0; extra == 'dev'
+Requires-Dist: isort==8.0.1; extra == 'dev'
+Requires-Dist: pytest<10.0.0,>=7.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# brlib
+
+[![Tests](https://github.com/john-bieren/brlib/actions/workflows/test.yml/badge.svg)](https://github.com/john-bieren/brlib/actions/workflows/test.yml)
+[![PyPI Latest Release](https://img.shields.io/pypi/v/brlib?label=PyPI&logo=pypi&logoColor=ffe873&color=0073b7)](https://pypi.org/project/brlib)
+[![Python Versions](https://img.shields.io/pypi/pyversions/brlib?label=Python%20Versions)](https://pypi.org/project/brlib)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+
+A library for collecting baseball statistics from
+[Baseball Reference](https://www.baseball-reference.com).
+
+> [!IMPORTANT]
+> brlib is in beta, breaking changes are possible until the release of version 1.
+
+## Key Features
+
+* `Game`, `Player`, and `Team` classes give you easy access to all associated data in one place,
+  with attributes for stats tables, information, and more.
+* Aggregate these into `GameSet`, `PlayerSet`, or `TeamSet` classes, which have similar attributes,
+  for easy analysis of larger samples.
+* Quickly search for games, players, and teams of interest, and gather their stats without violating
+  the [rate limit](https://www.sports-reference.com/429.html).
+
+Learn more by reading the documentation on the [wiki](https://github.com/john-bieren/brlib/wiki).
+
+## Install
+
+brlib can be installed using pip:
+
+```
+pip install brlib
+```
+
+or by cloning this repo, in which case you'll want to install the development dependencies as well:
+
+```
+pip install -e .[dev]
+```
+
+Once installed, you can import brlib into your Python scripts:
+
+```python
+import brlib as br
+```
+
+## Data Use
+
+Since brlib gathers data from Baseball Reference, your use of this data is subject to their
+[data use policy](https://www.sports-reference.com/data_use.html).

{brlib-0.2.0 → brlib-0.4.0}/README.md

@@ -2,17 +2,24 @@
 
 [![Tests](https://github.com/john-bieren/brlib/actions/workflows/test.yml/badge.svg)](https://github.com/john-bieren/brlib/actions/workflows/test.yml)
 [![PyPI Latest Release](https://img.shields.io/pypi/v/brlib?label=PyPI&logo=pypi&logoColor=ffe873&color=0073b7)](https://pypi.org/project/brlib)
+[![Python Versions](https://img.shields.io/pypi/pyversions/brlib?label=Python%20Versions)](https://pypi.org/project/brlib)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
 
-A library for collecting baseball statistics from [Baseball Reference](https://www.baseball-reference.com).
+A library for collecting baseball statistics from
+[Baseball Reference](https://www.baseball-reference.com).
 
 > [!IMPORTANT]
 > brlib is in beta, breaking changes are possible until the release of version 1.
 
 ## Key Features
 
-* `Game`, `Player`, and `Team` classes give you easy access to all associated data in one place, with attributes for stats tables, information, and more.
-* Aggregate these into `GameSet`, `PlayerSet`, or `TeamSet` classes, which have similar attributes, for easy analysis of larger samples.
-* Quickly search for games, players, and teams of interest, and gather their stats without violating the [rate limit](https://www.sports-reference.com/429.html).
+* `Game`, `Player`, and `Team` classes give you easy access to all associated data in one place,
+  with attributes for stats tables, information, and more.
+* Aggregate these into `GameSet`, `PlayerSet`, or `TeamSet` classes, which have similar attributes,
+  for easy analysis of larger samples.
+* Quickly search for games, players, and teams of interest, and gather their stats without violating
+  the [rate limit](https://www.sports-reference.com/429.html).
 
 Learn more by reading the documentation on the [wiki](https://github.com/john-bieren/brlib/wiki).
 
@@ -24,11 +31,9 @@ brlib can be installed using pip:
 pip install brlib
 ```
 
-or from this repo, in which case you'll want to install the development dependencies as well:
+or by cloning this repo, in which case you'll want to install the development dependencies as well:
 
 ```
-git clone https://github.com/john-bieren/brlib.git
-cd brlib
 pip install -e .[dev]
 ```
 
@@ -40,4 +45,5 @@ import brlib as br
 
 ## Data Use
 
-Since brlib gathers data from Baseball Reference, your use of this data is subject to their [data use policy](https://www.sports-reference.com/data_use.html).
+Since brlib gathers data from Baseball Reference, your use of this data is subject to their
+[data use policy](https://www.sports-reference.com/data_use.html).

{brlib-0.2.0 → brlib-0.4.0}/pyproject.toml

@@ -7,14 +7,14 @@ name = "brlib"
 description = "A library for collecting baseball statistics from Baseball Reference"
 authors = [{ name = "John Bieren", email = "jbieren64@gmail.com" }]
 dynamic = ["version"]
-requires-python = ">=3.12"
+requires-python = ">=3.10"
 dependencies = [
-    "pandas>=2.3.0,<3.0.0",
-    "beautifulsoup4>=4.14.0,<5.0.0",
-    "tqdm>=4.67.1,<5.0.0",
-    "curl-cffi>=0.13.0,<1.0.0",
-    "lxml>=6.0.2,<7.0.0",
-    "platformdirs>=4.5.0,<5.0.0"
+    "beautifulsoup4>=4.12.0,<4.15.0",
+    "curl-cffi>=0.11.1,<0.15.0",
+    "lxml>=5.0.0,<7.0.0",
+    "pandas>=2.2.0,<3.0.0",
+    "platformdirs>=4.0.0,<5.0.0",
+    "tqdm>=4.66.0,<5.0.0",
 ]
 readme = "README.md"
 license = "MIT"
@@ -22,24 +22,36 @@ license-files = ["LICENSE.txt"]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
-    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
-    "Operating System :: OS Independent",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Internet :: WWW/HTTP :: Indexing/Search",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+    "Topic :: Software Development :: Libraries :: Python Modules",
 ]
-keywords = ["baseball reference", "baseball", "baseball stats", "mlb"]
+keywords = ["baseball reference", "baseball", "baseball stats", "mlb", "mlb stats"]
 
 [project.optional-dependencies]
-dev = ["pytest>=9.0.0"]
+dev = [
+    "black==26.3.0",
+    "isort==8.0.1",
+    "pytest>=7.0.0,<10.0.0",
+]
 
 [project.urls]
-Homepage = "https://github.com/john-bieren/brlib"
 Documentation = "https://github.com/john-bieren/brlib/wiki"
-Repository = "https://github.com/john-bieren/brlib.git"
+GitHub = "https://github.com/john-bieren/brlib"
 Issues = "https://github.com/john-bieren/brlib/issues"
+"Release Notes" = "https://github.com/john-bieren/brlib/releases"
 
 [tool.hatch.version]
 path = "src/brlib/__init__.py"
@@ -47,3 +59,15 @@ path = "src/brlib/__init__.py"
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 pythonpath = ["src"]
+
+[tool.black]
+line-length = 100
+target-version = ["py310", "py311", "py312", "py313", "py314"]
+
+[tool.isort]
+profile = "black"
+line_length = 100
+known_first_party = ["brlib"]
+
+[tool.uv]
+package = true

brlib-0.4.0/scripts/refresh_tests.py

@@ -0,0 +1,125 @@
+#!/usr/bin/env python3
+
+"""
+Refreshes the expected data for games, players, and teams to match their current outputs. This is
+meant to automate the process of adapting to stat adjustments and other changes on Baseball
+Reference. All changes should be reviewed to make sure that they accurately reflect changes to the
+site, so as not to introduce errors into the test suite.
+"""
+
+import json
+from pathlib import Path
+
+from tqdm import tqdm
+
+import brlib as br
+
+
+def main():
+    """Refreshes the expected data for games, players, and teams to match their current outputs."""
+    expected_dir = Path(__file__).parent.parent / "tests" / "expected"
+    br.options.add_no_hitters = False
+    br.options.update_team_names = False
+    br.options.update_venue_names = False
+
+    tqdm.write("Refreshing expected game data")
+    refresh_games(expected_dir / "games")
+
+    tqdm.write("Refreshing expected player data")
+    refresh_players(expected_dir / "players")
+
+    tqdm.write("Refreshing expected team data")
+    refresh_teams(expected_dir / "teams")
+
+
+def refresh_games(games_dir: Path) -> None:
+    """Refreshes expected data for games in `games_dir`."""
+    ids_dir = games_dir / "original"
+    total = sum(1 for entry in ids_dir.iterdir() if entry.is_dir())
+    for game_dir in tqdm(ids_dir.iterdir(), total=total, unit="game"):
+        if not game_dir.is_dir():
+            continue
+
+        # refresh original data
+        game = br.Game(game_dir.name)
+        original_dir = games_dir / "original" / game_dir.name
+        game.info.to_csv(original_dir / "info.csv", index=False)
+        game.batting.to_csv(original_dir / "batting.csv", index=False)
+        game.pitching.to_csv(original_dir / "pitching.csv", index=False)
+        game.fielding.to_csv(original_dir / "fielding.csv", index=False)
+        game.team_info.to_csv(original_dir / "team_info.csv", index=False)
+        game.ump_info.to_csv(original_dir / "ump_info.csv", index=False)
+        game.linescore.to_csv(original_dir / "linescore.csv", index=False)
+        (original_dir / "players.json").write_text(json.dumps(game.players))
+        (original_dir / "teams.json").write_text(json.dumps(game.teams))
+
+        # refresh updated data
+        game.add_no_hitters()
+        game.update_team_names()
+        game.update_venue_names()
+        updated_dir = games_dir / "updated" / game_dir.name
+        game.info.to_csv(updated_dir / "info.csv", index=False)
+        game.batting.to_csv(updated_dir / "batting.csv", index=False)
+        game.pitching.to_csv(updated_dir / "pitching.csv", index=False)
+        game.fielding.to_csv(updated_dir / "fielding.csv", index=False)
+        game.team_info.to_csv(updated_dir / "team_info.csv", index=False)
+        game.linescore.to_csv(updated_dir / "linescore.csv", index=False)
+
+
+def refresh_players(players_dir: Path) -> None:
+    """Refreshes expected data for players in `players_dir`."""
+    ids_dir = players_dir / "original"
+    total = sum(1 for entry in ids_dir.iterdir() if entry.is_dir())
+    for player_dir in tqdm(ids_dir.iterdir(), total=total, unit="player"):
+        if not player_dir.is_dir():
+            continue
+
+        # refresh original data
+        player = br.Player(player_dir.name)
+        original_dir = players_dir / "original" / player_dir.name
+        player.info.to_csv(original_dir / "info.csv", index=False)
+        player.bling.to_csv(original_dir / "bling.csv", index=False)
+        player.batting.to_csv(original_dir / "batting.csv", index=False)
+        player.pitching.to_csv(original_dir / "pitching.csv", index=False)
+        player.fielding.to_csv(original_dir / "fielding.csv", index=False)
+        (original_dir / "relatives.json").write_text(json.dumps(player.relatives))
+        (original_dir / "teams.json").write_text(json.dumps(player.teams))
+
+        # refresh updated data
+        player.add_no_hitters()
+        player.update_team_names()
+        updated_dir = players_dir / "updated" / player_dir.name
+        player.info.to_csv(updated_dir / "info.csv", index=False)
+        player.pitching.to_csv(updated_dir / "pitching.csv", index=False)
+
+
+def refresh_teams(teams_dir: Path) -> None:
+    """Refreshes expected data for the teams in `teams_dir`."""
+    ids_dir = teams_dir / "original"
+    total = sum(1 for entry in ids_dir.iterdir() if entry.is_dir())
+    for team_dir in tqdm(ids_dir.iterdir(), total=total, unit="team"):
+        if not team_dir.is_dir():
+            continue
+
+        # refresh original data
+        team = br.Team(team_dir.name)
+        original_dir = teams_dir / "original" / team_dir.name
+        team.info.to_csv(original_dir / "info.csv", index=False)
+        team.batting.to_csv(original_dir / "batting.csv", index=False)
+        team.pitching.to_csv(original_dir / "pitching.csv", index=False)
+        team.fielding.to_csv(original_dir / "fielding.csv", index=False)
+        (original_dir / "players.json").write_text(json.dumps(team.players))
+
+        # refresh updated data
+        team.add_no_hitters()
+        team.update_team_names()
+        team.update_venue_names()
+        updated_dir = teams_dir / "updated" / team_dir.name
+        team.info.to_csv(updated_dir / "info.csv", index=False)
+        team.batting.to_csv(updated_dir / "batting.csv", index=False)
+        team.pitching.to_csv(updated_dir / "pitching.csv", index=False)
+        team.fielding.to_csv(updated_dir / "fielding.csv", index=False)
+
+
+if __name__ == "__main__":
+    main()

brlib-0.4.0/scripts/refresh_wiki.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python3
+
+"""
+Copies public member docstrings into Markdown files in an adjacent "wiki" directory,
+presumably a clone of brlib's GitHub wiki repo. This is used to refresh the wiki's contents.
+"""
+
+import inspect
+from pathlib import Path
+
+from tqdm import tqdm
+
+import brlib
+
+
+def main() -> None:
+    """
+    Copies public member docstrings into Markdown files in an adjacent "wiki" directory,
+    presumably a clone of brlib's GitHub wiki repo. This is used to refresh the wiki's contents.
+    """
+    tqdm.write("Refreshing wiki files")
+    wiki_dir = Path(__file__).parent.parent / "wiki"
+    public_members = {
+        name: mem for name, mem in inspect.getmembers(brlib) if not name.startswith("_")
+    }
+
+    for member_name, member in tqdm(public_members.items(), unit="files"):
+        if inspect.ismodule(member):
+            continue
+        file_path = wiki_dir / f"{member_name}.md"
+        file_path.write_text(clean_docstring(member.__doc__), encoding="UTF-8")
+
+        # for classes or variables which are the instantiation of a singleton class
+        if not inspect.isfunction(member):
+            # create files for each of the class's public methods
+            methods = inspect.getmembers(member, predicate=is_function_or_method)
+            public_methods = {name: mem for name, mem in methods if not name.startswith("_")}
+            for method_name, method in public_methods.items():
+                file_path = wiki_dir / f"{member_name}.{method_name}.md"
+                file_path.write_text(clean_docstring(method.__doc__), encoding="UTF-8")
+
+
+def clean_docstring(docstring: str) -> str:
+    """Reformat whitespace in `docstring`."""
+    # remove leading newline
+    if docstring.startswith("\n"):
+        docstring = docstring[1:]
+    return docstring
+
+
+def is_function_or_method(member: object) -> bool:
+    """
+    Checks whether `inspect.isfunction` or `inspect.ismethod` is `True`. `isfunction` finds methods
+    if `member` is a class, and `ismethod` finds methods if `member` is a class instance.
+    """
+    return inspect.isfunction(member) or inspect.ismethod(member)
+
+
+if __name__ == "__main__":
+    main()

{brlib-0.2.0 → brlib-0.4.0}/src/brlib/__init__.py

@@ -1,4 +1,11 @@
-from .all_major_leaguers import all_major_leaguers
+"""
+A library for collecting baseball statistics from [Baseball
+Reference](https://www.baseball-reference.com).
+
+Documentation can be found on the [wiki](https://github.com/john-bieren/brlib/wiki).
+"""
+
+from .all_players import all_players
 from .find_asg import find_asg
 from .find_games import find_games
 from .find_teams import find_teams
@@ -13,10 +20,10 @@ from .player_set import PlayerSet
 from .team import Team
 from .team_set import TeamSet
 
-__version__ = "0.2.0"
+__version__ = "0.4.0"
 
 __all__ = [
-    "all_major_leaguers",
+    "all_players",
     "find_asg",
     "find_games",
     "find_teams",
@@ -29,5 +36,5 @@ __all__ = [
     "Player",
     "PlayerSet",
     "Team",
-    "TeamSet"
+    "TeamSet",
 ]

brlib-0.4.0/src/brlib/_helpers/__init__.py

@@ -0,0 +1,4 @@
+"""
+Functions, classes, and constants internal to the codebase.
+External use of this module is strongly discouraged, and its API may change without notice.
+"""