rlstatsapi 0.1.5__tar.gz → 0.1.7__tar.gz

{rlstatsapi-0.1.5/src/rlstatsapi.egg-info → rlstatsapi-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rlstatsapi
-Version: 0.1.5
+Version: 0.1.7
 Summary: Rocket League Stats API client
 Author: Manuel Cabral
 License-Expression: MIT
@@ -19,17 +19,18 @@ License-File: LICENSE
 Provides-Extra: dev
 Requires-Dist: pytest>=8; extra == "dev"
 Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: black; extra == "dev"
 Dynamic: license-file
 
-<img width="600" alt="rlstatsapi-logo" src="https://github.com/manucabral/RocketLeagueStatsAPI/blob/main/docs/assets/social-preview.png" />
+<img width="600" alt="rlstatsapi-logo" src="https://github.com/manucabral/rlstatsapi/blob/main/docs/assets/social-preview.png" />
 
 # Rocket League Stats API
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![PyPI version](https://img.shields.io/pypi/v/rlstatsapi.svg)](https://pypi.org/project/rlstatsapi/) [![Pylint](https://github.com/manucabral/RocketLeagueStatsAPI/actions/workflows/pylint.yml/badge.svg)](https://github.com/manucabral/RocketLeagueStatsAPI/actions/workflows/pylint.yml)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![PyPI version](https://img.shields.io/pypi/v/rlstatsapi.svg)](https://pypi.org/project/rlstatsapi/) [![Pylint](https://github.com/manucabral/rlstatsapi/actions/workflows/pylint.yml/badge.svg)](https://github.com/manucabral/rlstatsapi/actions/workflows/pylint.yml)
 ![Downloads](https://img.shields.io/pypi/dm/rlstatsapi)
 
 `rlstatsapi` is a small Python client for reading live Rocket League Stats API events over a local TCP socket.
 
-- Full docs: [manucabral.github.io/RocketLeagueStatsAPI](https://manucabral.github.io/RocketLeagueStatsAPI/)
+- Full docs: [manucabral.github.io/rlstatsapi](https://manucabral.github.io/rlstatsapi/)
 - Release history: [CHANGELOG.md](CHANGELOG.md)
 
 ## Install
@@ -43,7 +44,7 @@ pip install rlstatsapi
 From GitHub:
 
 ```bash
-pip install git+https://github.com/manucabral/RocketLeagueStatsAPI.git
+pip install git+https://github.com/manucabral/rlstatsapi.git
 ```
 
 ## Rocket League setup
@@ -126,7 +127,7 @@ def on_goal(msg: EventMessage) -> None:
 
 ## More
 
-- Full docs: [manucabral.github.io/RocketLeagueStatsAPI](https://manucabral.github.io/RocketLeagueStatsAPI/)
+- Full docs: [manucabral.github.io/rlstatsapi](https://manucabral.github.io/rlstatsapi/)
 - Examples: [examples/](examples)
 - Release history: [CHANGELOG.md](CHANGELOG.md)
 
@@ -144,6 +145,6 @@ Use this library at your own risk and in compliance with Rocket League’s terms
 
 ## Contributors
 
-<a href="https://github.com/manucabral/RocketLeagueStatsAPI/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=manucabral/RocketLeagueStatsAPI" alt="Contributors" />
+<a href="https://github.com/manucabral/rlstatsapi/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=manucabral/rlstatsapi" alt="Contributors" />
 </a>

{rlstatsapi-0.1.5 → rlstatsapi-0.1.7}/README.md

@@ -1,12 +1,12 @@
-<img width="600" alt="rlstatsapi-logo" src="https://github.com/manucabral/RocketLeagueStatsAPI/blob/main/docs/assets/social-preview.png" />
+<img width="600" alt="rlstatsapi-logo" src="https://github.com/manucabral/rlstatsapi/blob/main/docs/assets/social-preview.png" />
 
 # Rocket League Stats API
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![PyPI version](https://img.shields.io/pypi/v/rlstatsapi.svg)](https://pypi.org/project/rlstatsapi/) [![Pylint](https://github.com/manucabral/RocketLeagueStatsAPI/actions/workflows/pylint.yml/badge.svg)](https://github.com/manucabral/RocketLeagueStatsAPI/actions/workflows/pylint.yml)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![PyPI version](https://img.shields.io/pypi/v/rlstatsapi.svg)](https://pypi.org/project/rlstatsapi/) [![Pylint](https://github.com/manucabral/rlstatsapi/actions/workflows/pylint.yml/badge.svg)](https://github.com/manucabral/rlstatsapi/actions/workflows/pylint.yml)
 ![Downloads](https://img.shields.io/pypi/dm/rlstatsapi)
 
 `rlstatsapi` is a small Python client for reading live Rocket League Stats API events over a local TCP socket.
 
-- Full docs: [manucabral.github.io/RocketLeagueStatsAPI](https://manucabral.github.io/RocketLeagueStatsAPI/)
+- Full docs: [manucabral.github.io/rlstatsapi](https://manucabral.github.io/rlstatsapi/)
 - Release history: [CHANGELOG.md](CHANGELOG.md)
 
 ## Install
@@ -20,7 +20,7 @@ pip install rlstatsapi
 From GitHub:
 
 ```bash
-pip install git+https://github.com/manucabral/RocketLeagueStatsAPI.git
+pip install git+https://github.com/manucabral/rlstatsapi.git
 ```
 
 ## Rocket League setup
@@ -103,7 +103,7 @@ def on_goal(msg: EventMessage) -> None:
 
 ## More
 
-- Full docs: [manucabral.github.io/RocketLeagueStatsAPI](https://manucabral.github.io/RocketLeagueStatsAPI/)
+- Full docs: [manucabral.github.io/rlstatsapi](https://manucabral.github.io/rlstatsapi/)
 - Examples: [examples/](examples)
 - Release history: [CHANGELOG.md](CHANGELOG.md)
 
@@ -121,6 +121,6 @@ Use this library at your own risk and in compliance with Rocket League’s terms
 
 ## Contributors
 
-<a href="https://github.com/manucabral/RocketLeagueStatsAPI/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=manucabral/RocketLeagueStatsAPI" alt="Contributors" />
+<a href="https://github.com/manucabral/rlstatsapi/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=manucabral/rlstatsapi" alt="Contributors" />
 </a>

{rlstatsapi-0.1.5 → rlstatsapi-0.1.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rlstatsapi"
-version = "0.1.5"
+version = "0.1.7"
 description = "Rocket League Stats API client"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -28,7 +28,7 @@ Repository = "https://github.com/manucabral/RocketLeagueStatsAPI"
 rlstatsapi = "rlstatsapi.__main__:main"
 
 [project.optional-dependencies]
-dev = ["pytest>=8", "pytest-asyncio>=0.23"]
+dev = ["pytest>=8", "pytest-asyncio>=0.23", "black"]
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto"

{rlstatsapi-0.1.5 → rlstatsapi-0.1.7}/src/rlstatsapi/__init__.py

@@ -1,14 +1,11 @@
-"""
-Public package surface for rlstatsapi.
+"""Public package interface for ``rlstatsapi``."""
 
-Re-exports the client, envelope model, known event constants, and typed payload
-helpers so consumers can import from `rlstatsapi` directly.
-"""
+from __future__ import annotations
 
 from importlib.metadata import PackageNotFoundError
 from importlib.metadata import version as _pkg_version
 
-from .client import StatsClient
+from .client import ConnectionState, StatsClient
 from .config import (
     DEFAULT_PACKET_SEND_RATE,
     DEFAULT_STATS_API_FILENAME,
@@ -22,7 +19,7 @@ from .config import (
     set_stats_api_port,
 )
 from .events import KNOWN_EVENTS
-from .models import ClientMetrics, EventMessage, MatchStateSnapshot
+from .models import ClientMetrics, EventMessage, MatchStateSnapshot, PlayerSnapshot
 from .state import MatchStateTracker
 from .types import (
     BallHitPayload,
@@ -58,10 +55,12 @@ except PackageNotFoundError:
 __all__ = [
     "__version__",
     "StatsClient",
+    "ConnectionState",
     "StatsAPIConfigStatus",
     "EventMessage",
     "ClientMetrics",
     "MatchStateSnapshot",
+    "PlayerSnapshot",
     "MatchStateTracker",
     "KNOWN_EVENTS",
     "DEFAULT_PACKET_SEND_RATE",

{rlstatsapi-0.1.5 → rlstatsapi-0.1.7}/src/rlstatsapi/__main__.py

@@ -1,4 +1,4 @@
-"""Command-line entrypoint for common rlstatsapi setup and debugging tasks."""
+"""Command-line interface for ``rlstatsapi`` configuration and live listening."""
 
 from __future__ import annotations
 
@@ -19,13 +19,21 @@ from .config import (
 
 
 def main(argv: Sequence[str] | None = None) -> int:
-    """Parse CLI args and dispatch the requested command."""
+    """Parse CLI arguments and run the selected subcommand.
+
+    Args:
+        argv: Optional list of CLI arguments. Defaults to ``sys.argv[1:]``.
+
+    Returns:
+        int: Process exit code.
+    """
     parser = _build_parser()
     args = parser.parse_args(argv)
     return args.func(args)
 
 
 def _build_parser() -> argparse.ArgumentParser:
+    """Create the top-level argument parser and register subcommands."""
     parser = argparse.ArgumentParser(prog="rlstatsapi")
     subparsers = parser.add_subparsers(dest="command", required=True)
 
@@ -87,12 +95,14 @@ def _build_parser() -> argparse.ArgumentParser:
 
 
 def _run_status(args: argparse.Namespace) -> int:
+    """Print the current ``TAStatsAPI.ini`` status as formatted JSON."""
     status = get_stats_api_status(args.path)
     print(json.dumps(asdict(status), indent=2))
     return 0
 
 
 def _run_enable(args: argparse.Namespace) -> int:
+    """Enable the Stats API exporter in ``TAStatsAPI.ini`` and print the result."""
     status = configure_stats_api(
         enabled=True,
         port=args.port,
@@ -105,6 +115,7 @@ def _run_enable(args: argparse.Namespace) -> int:
 
 
 def _run_disable(args: argparse.Namespace) -> int:
+    """Disable the Stats API exporter in ``TAStatsAPI.ini`` and print the result."""
     status = configure_stats_api(
         enabled=False,
         port=args.port,
@@ -117,10 +128,12 @@ def _run_disable(args: argparse.Namespace) -> int:
 
 
 def _run_listen(args: argparse.Namespace) -> int:
+    """Run the async ``_listen`` coroutine from the synchronous CLI handler."""
     return asyncio.run(_listen(args))
 
 
 async def _listen(args: argparse.Namespace) -> int:
+    """Connect to the local Stats API and print incoming events until interrupted."""
     async with StatsClient(
         host=args.host,
         port=args.port,