mini-arcade-core 0.3.2__tar.gz → 0.5.2__tar.gz

{mini_arcade_core-0.3.2 → mini_arcade_core-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mini-arcade-core
-Version: 0.3.2
+Version: 0.5.2
 Summary: Tiny scene-based game loop core for small arcade games.
 License: Copyright (c) 2025 Santiago Rincón
            

{mini_arcade_core-0.3.2 → mini_arcade_core-0.5.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "mini-arcade-core"
-version = "0.3.2"
+version = "0.5.2"
 description = "Tiny scene-based game loop core for small arcade games."
 authors = [
     { name = "Santiago Rincon", email = "rincores@gmail.com" },
@@ -57,6 +57,8 @@ strict = false
 disable = [
     # Justification: Allow classes with few public methods for simplicity.
     "too-few-public-methods",
+    # Justification: f-strings are preferred for logging.
+    "logging-fstring-interpolation",
     # Justification: TODOs are acceptable during development.
     "fixme",
 ]

mini_arcade_core-0.5.2/src/mini_arcade_core/__init__.py

@@ -0,0 +1,76 @@
+"""
+Entry point for the mini_arcade_core package.
+Provides access to core classes and a convenience function to run a game.
+"""
+
+from __future__ import annotations
+
+import logging
+from importlib.metadata import PackageNotFoundError, version
+
+from .backend import Backend, Event, EventType
+from .entity import Entity, SpriteEntity
+from .game import Game, GameConfig
+from .scene import Scene
+
+logger = logging.getLogger(__name__)
+
+
+def run_game(initial_scene_cls: type[Scene], config: GameConfig | None = None):
+    """
+    Convenience helper to bootstrap and run a game with a single scene.
+
+    :param initial_scene_cls: The Scene subclass to instantiate as the initial scene.
+    :param config: Optional GameConfig to customize game settings.
+    """
+    game = Game(config or GameConfig())
+    scene = initial_scene_cls(game)
+    game.run(scene)
+
+
+__all__ = [
+    "Game",
+    "GameConfig",
+    "Scene",
+    "Entity",
+    "SpriteEntity",
+    "run_game",
+    "Backend",
+    "Event",
+    "EventType",
+]
+
+PACKAGE_NAME = "mini-arcade-core"  # or whatever is in your pyproject.toml
+
+
+def get_version() -> str:
+    """
+    Return the installed package version.
+
+    This is a thin helper around importlib.metadata.version so games can do:
+
+        from mini_arcade_core import get_version
+        print(get_version())
+
+    :return: The version string of the installed package.
+    :rtype: str
+
+    :raises PackageNotFoundError: If the package is not installed.
+    """
+    try:
+        return version(PACKAGE_NAME)
+    except PackageNotFoundError:  # if running from source / editable
+        logger.warning(
+            f"Package '{PACKAGE_NAME}' not found. Returning default version '0.0.0'."
+        )
+        return "0.0.0"
+
+
+try:
+    __version__ = get_version()
+# Justification: We want to ensure that any exception during version retrieval
+# results in a default version being set, rather than crashing the import.
+# pylint: disable=broad-exception-caught
+except Exception:
+    __version__ = "0.0.0"
+# pylint: enable=broad-exception-caught

{mini_arcade_core-0.3.2 → mini_arcade_core-0.5.2}/src/mini_arcade_core/game.py

@@ -7,6 +7,8 @@ from __future__ import annotations
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
+from .backend import Backend
+
 if TYPE_CHECKING:  # avoid runtime circular import
     from .scene import Scene
 
@@ -21,6 +23,7 @@ class GameConfig:
     :ivar title: Title of the game window.
     :ivar fps: Target frames per second.
     :ivar background_color: RGB background color.
+    :ivar backend: Optional backend class to use for rendering and input.
     """
 
     width: int = 800
@@ -28,6 +31,7 @@ class GameConfig:
     title: str = "Mini Arcade Game"
     fps: int = 60
     background_color: tuple[int, int, int] = (0, 0, 0)
+    backend: type[Backend] | None = None
 
 
 class Game:
@@ -40,6 +44,7 @@ class Game:
         self.config = config
         self._current_scene: Scene | None = None
         self._running: bool = False
+        self.backend: Backend | None = config.backend
 
     def change_scene(self, scene: Scene):
         """
@@ -52,6 +57,10 @@ class Game:
             "Game.change_scene must be implemented by a concrete backend."
         )
 
+    def quit(self):
+        """Request that the main loop stops."""
+        self._running = False
+
     def run(self, initial_scene: Scene):
         """
         Run the main loop starting with the given scene.

mini_arcade_core-0.3.2/src/mini_arcade_core/__init__.py

@@ -1,36 +0,0 @@
-"""
-Entry point for the mini_arcade_core package.
-Provides access to core classes and a convenience function to run a game.
-"""
-
-from __future__ import annotations
-
-from .backend import Backend, Event, EventType
-from .entity import Entity, SpriteEntity
-from .game import Game, GameConfig
-from .scene import Scene
-
-
-def run_game(initial_scene_cls: type[Scene], config: GameConfig | None = None):
-    """
-    Convenience helper to bootstrap and run a game with a single scene.
-
-    :param initial_scene_cls: The Scene subclass to instantiate as the initial scene.
-    :param config: Optional GameConfig to customize game settings.
-    """
-    game = Game(config or GameConfig())
-    scene = initial_scene_cls(game)
-    game.run(scene)
-
-
-__all__ = [
-    "Game",
-    "GameConfig",
-    "Scene",
-    "Entity",
-    "SpriteEntity",
-    "run_game",
-    "Backend",
-    "Event",
-    "EventType",
-]