gameviz-hyperkit 0.1.2__tar.gz → 0.2.0__tar.gz

{gameviz_hyperkit-0.1.2/src/gameviz_hyperkit.egg-info → gameviz_hyperkit-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gameviz-hyperkit
-Version: 0.1.2
+Version: 0.2.0
 Summary: A lightweight Python SDK for 2D hypercasual and hybrid-casual mobile game prototypes.
 Author-email: "Md. Rifat Hossain Chowdhury" <rifat.gameviz@gmail.com>
 License-Expression: MIT
@@ -52,13 +52,15 @@ HyperKit is publicly available on PyPI and remains in active alpha development.
 
 Current package status:
 
-- Current package version: `0.1.2`
+- Current package version: `0.2.0`
 - Installation command: `pip install gameviz-hyperkit`
 - Package maturity: Alpha / early SDK preview
 - API stability target: future `1.0.0`
 - Supported Python versions: Python 3.9–3.12
 
-HyperKit is suitable for learning, prototyping, game jams, and early 2D mobile game experiments. It is not yet intended to replace a full production game engine.
+HyperKit `0.2.0` establishes the core SDK architecture, including runtime context, structured logging, project configuration, platform detection, lifecycle management, deprecation support, and a protected public API contract.
+
+HyperKit is suitable for learning, prototyping, game jams, and early 2D mobile game development. It is not yet intended to replace a full production game engine.
 
 ---
 
@@ -472,6 +474,7 @@ Package publication is handled through the project's controlled release workflow
 - [Manual QA Result Template](docs/MANUAL_QA_RESULT_TEMPLATE.md)
 - [Release Evidence Structure](docs/RELEASE_EVIDENCE_STRUCTURE.md)
 - [Release Evidence Workspace](docs/release-evidence/README.md)
+- [Roadmap to HyperKit 1.0](ROADMAP.md)
 
 ### Template Polish and Runtime Documentation
 
@@ -486,7 +489,6 @@ Package publication is handled through the project's controlled release workflow
 - [Template Runtime Readiness - Phase 56](docs/TEMPLATE_RUNTIME_READINESS_PHASE56.md)
 - [Runtime QA Tracker - Phase 58](docs/RUNTIME_QA_TRACKER_PHASE58.md)
 
----
 ---
 
 ## Current Limitations

{gameviz_hyperkit-0.1.2 → gameviz_hyperkit-0.2.0}/README.md

@@ -19,13 +19,15 @@ HyperKit is publicly available on PyPI and remains in active alpha development.
 
 Current package status:
 
-- Current package version: `0.1.2`
+- Current package version: `0.2.0`
 - Installation command: `pip install gameviz-hyperkit`
 - Package maturity: Alpha / early SDK preview
 - API stability target: future `1.0.0`
 - Supported Python versions: Python 3.9–3.12
 
-HyperKit is suitable for learning, prototyping, game jams, and early 2D mobile game experiments. It is not yet intended to replace a full production game engine.
+HyperKit `0.2.0` establishes the core SDK architecture, including runtime context, structured logging, project configuration, platform detection, lifecycle management, deprecation support, and a protected public API contract.
+
+HyperKit is suitable for learning, prototyping, game jams, and early 2D mobile game development. It is not yet intended to replace a full production game engine.
 
 ---
 
@@ -439,6 +441,7 @@ Package publication is handled through the project's controlled release workflow
 - [Manual QA Result Template](docs/MANUAL_QA_RESULT_TEMPLATE.md)
 - [Release Evidence Structure](docs/RELEASE_EVIDENCE_STRUCTURE.md)
 - [Release Evidence Workspace](docs/release-evidence/README.md)
+- [Roadmap to HyperKit 1.0](ROADMAP.md)
 
 ### Template Polish and Runtime Documentation
 
@@ -453,7 +456,6 @@ Package publication is handled through the project's controlled release workflow
 - [Template Runtime Readiness - Phase 56](docs/TEMPLATE_RUNTIME_READINESS_PHASE56.md)
 - [Runtime QA Tracker - Phase 58](docs/RUNTIME_QA_TRACKER_PHASE58.md)
 
----
 ---
 
 ## Current Limitations

{gameviz_hyperkit-0.1.2 → gameviz_hyperkit-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gameviz-hyperkit"
-version = "0.1.2"
+version = "0.2.0"
 description = "A lightweight Python SDK for 2D hypercasual and hybrid-casual mobile game prototypes."
 readme = "README.md"
 requires-python = ">=3.9"

{gameviz_hyperkit-0.1.2 → gameviz_hyperkit-0.2.0/src/gameviz_hyperkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gameviz-hyperkit
-Version: 0.1.2
+Version: 0.2.0
 Summary: A lightweight Python SDK for 2D hypercasual and hybrid-casual mobile game prototypes.
 Author-email: "Md. Rifat Hossain Chowdhury" <rifat.gameviz@gmail.com>
 License-Expression: MIT
@@ -52,13 +52,15 @@ HyperKit is publicly available on PyPI and remains in active alpha development.
 
 Current package status:
 
-- Current package version: `0.1.2`
+- Current package version: `0.2.0`
 - Installation command: `pip install gameviz-hyperkit`
 - Package maturity: Alpha / early SDK preview
 - API stability target: future `1.0.0`
 - Supported Python versions: Python 3.9–3.12
 
-HyperKit is suitable for learning, prototyping, game jams, and early 2D mobile game experiments. It is not yet intended to replace a full production game engine.
+HyperKit `0.2.0` establishes the core SDK architecture, including runtime context, structured logging, project configuration, platform detection, lifecycle management, deprecation support, and a protected public API contract.
+
+HyperKit is suitable for learning, prototyping, game jams, and early 2D mobile game development. It is not yet intended to replace a full production game engine.
 
 ---
 
@@ -472,6 +474,7 @@ Package publication is handled through the project's controlled release workflow
 - [Manual QA Result Template](docs/MANUAL_QA_RESULT_TEMPLATE.md)
 - [Release Evidence Structure](docs/RELEASE_EVIDENCE_STRUCTURE.md)
 - [Release Evidence Workspace](docs/release-evidence/README.md)
+- [Roadmap to HyperKit 1.0](ROADMAP.md)
 
 ### Template Polish and Runtime Documentation
 
@@ -486,7 +489,6 @@ Package publication is handled through the project's controlled release workflow
 - [Template Runtime Readiness - Phase 56](docs/TEMPLATE_RUNTIME_READINESS_PHASE56.md)
 - [Runtime QA Tracker - Phase 58](docs/RUNTIME_QA_TRACKER_PHASE58.md)
 
----
 ---
 
 ## Current Limitations

{gameviz_hyperkit-0.1.2 → gameviz_hyperkit-0.2.0}/src/gameviz_hyperkit.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ src/gameviz_hyperkit.egg-info/top_level.txt
 src/hyperkit/__init__.py
 src/hyperkit/android.py
 src/hyperkit/animation.py
+src/hyperkit/api_contract.py
 src/hyperkit/app.py
 src/hyperkit/assets.py
 src/hyperkit/audio.py
@@ -19,6 +20,11 @@ src/hyperkit/camera.py
 src/hyperkit/camera_follow.py
 src/hyperkit/cli.py
 src/hyperkit/collision.py
+src/hyperkit/compatibility.py
+src/hyperkit/config.py
+src/hyperkit/deprecation.py
+src/hyperkit/environment.py
+src/hyperkit/errors.py
 src/hyperkit/generated_project_validation.py
 src/hyperkit/geometry.py
 src/hyperkit/health.py
@@ -26,12 +32,16 @@ src/hyperkit/input.py
 src/hyperkit/input_actions.py
 src/hyperkit/layout.py
 src/hyperkit/level.py
+src/hyperkit/lifecycle.py
+src/hyperkit/logging.py
 src/hyperkit/object.py
 src/hyperkit/particle.py
 src/hyperkit/physics.py
 src/hyperkit/progress.py
+src/hyperkit/project_config.py
 src/hyperkit/release.py
 src/hyperkit/release_evidence.py
+src/hyperkit/runtime.py
 src/hyperkit/save.py
 src/hyperkit/scene.py
 src/hyperkit/score.py
@@ -64,6 +74,7 @@ tests/test_changelog_phase36.py
 tests/test_cli_error_messages_phase45.py
 tests/test_cli_templates.py
 tests/test_collision.py
+tests/test_core_api_foundation_phase70.py
 tests/test_examples_syntax.py
 tests/test_final_qa_certification_phase65.py
 tests/test_flappy_mini_polish_phase49.py
@@ -75,10 +86,13 @@ tests/test_health_phase38.py
 tests/test_input_actions.py
 tests/test_layout.py
 tests/test_level.py
+tests/test_logging_environment_phase72.py
 tests/test_particle.py
+tests/test_phase72_completion.py
 tests/test_pre_release_audit_phase40.py
 tests/test_production_template_polish_phase47.py
 tests/test_progress.py
+tests/test_project_config_deprecation_phase72.py
 tests/test_public_readme_phase42.py
 tests/test_puzzle_game_polish_phase51.py
 tests/test_puzzle_game_runtime_qa_phase62.py
@@ -88,6 +102,7 @@ tests/test_quiz_game_runtime_qa_phase63.py
 tests/test_release_check_phase39.py
 tests/test_release_evidence_phase57.py
 tests/test_release_readiness_phase35.py
+tests/test_runtime_context_phase71.py
 tests/test_runtime_qa_tracker_phase58.py
 tests/test_score_save.py
 tests/test_simple_physics_polish_phase53.py

{gameviz_hyperkit-0.1.2 → gameviz_hyperkit-0.2.0}/src/hyperkit/__init__.py

@@ -3,7 +3,38 @@
 A lightweight Python SDK for mobile-ready 2D hypercasual game prototypes.
 """
 
-from .collision import circle_intersects_circle, rect_intersects_rect, rect_intersects_circle
+from .errors import (
+    HyperKitCompatibilityError,
+    HyperKitConfigurationError,
+    HyperKitError,
+    HyperKitRuntimeError,
+    HyperKitValidationError,
+)
+
+from .compatibility import (
+    API_VERSION,
+    get_api_version,
+    is_api_compatible,
+    require_api_version,
+)
+
+from .config import SDKConfig
+
+from .runtime import (
+    RuntimeState,
+    SDKContext,
+    create_context,
+    get_default_context,
+    reset_default_context,
+    set_default_context,
+)
+
+from .collision import (
+    circle_intersects_circle,
+    rect_intersects_circle,
+    rect_intersects_rect,
+)
+
 from .geometry import Circle, Rect, Vector2
 from .input import TouchEvent, TouchGesture, TouchTracker
 from .object import GameObject
@@ -14,6 +45,7 @@ from .score import ScoreManager
 from .ui import Button, TextLabel
 from .state import GameState, StateMachine
 from .layout import CanvasScaler
+
 from .assets import (
     AssetError,
     AssetManager,
@@ -26,6 +58,7 @@ from .assets import (
     load_json,
     load_text,
 )
+
 from .audio import (
     AudioError,
     AudioLoadError,
@@ -34,6 +67,7 @@ from .audio import (
     play_sound,
     stop_music,
 )
+
 from .animation import (
     AnimationManager,
     ColorTween,
@@ -43,19 +77,81 @@ from .animation import (
     ease_out_quad,
     linear,
 )
-from .sprite import SpriteAnimation, SpriteAnimationError, SpriteAnimator
-from .particle import Particle, ParticleConfig, ParticleEmitter
+
+from .sprite import (
+    SpriteAnimation,
+    SpriteAnimationError,
+    SpriteAnimator,
+)
+
+from .particle import (
+    Particle,
+    ParticleConfig,
+    ParticleEmitter,
+)
+
 from .camera import CameraShake
-from .transition import SceneTransition, SceneTransitionError
-from .timers import Cooldown, Timer, TimerError, TimerManager
-from .input_actions import InputActionBinding, InputActionEvent, InputActionMap
-from .level import LevelData, LevelError, LevelLoader, LevelManager, load_level
+
+from .transition import (
+    SceneTransition,
+    SceneTransitionError,
+)
+
+from .timers import (
+    Cooldown,
+    Timer,
+    TimerError,
+    TimerManager,
+)
+
+from .input_actions import (
+    InputActionBinding,
+    InputActionEvent,
+    InputActionMap,
+)
+
+from .level import (
+    LevelData,
+    LevelError,
+    LevelLoader,
+    LevelManager,
+    load_level,
+)
+
 from .camera_follow import CameraFollow
-from .bounds import Bounds, BoundsManager, ScreenBounds, WorldBounds
-from .progress import ProgressBar, ProgressBarError
-from .health import HealthCheck, HealthReport, format_health_report, generate_health_report
-from .release import ReleaseCheck, ReleaseReport, format_release_report, generate_release_report
-from .audit import PreReleaseAuditCheck, PreReleaseAuditReport, format_pre_release_audit_report, generate_pre_release_audit_report
+
+from .bounds import (
+    Bounds,
+    BoundsManager,
+    ScreenBounds,
+    WorldBounds,
+)
+
+from .progress import (
+    ProgressBar,
+    ProgressBarError,
+)
+
+from .health import (
+    HealthCheck,
+    HealthReport,
+    format_health_report,
+    generate_health_report,
+)
+
+from .release import (
+    ReleaseCheck,
+    ReleaseReport,
+    format_release_report,
+    generate_release_report,
+)
+
+from .audit import (
+    PreReleaseAuditCheck,
+    PreReleaseAuditReport,
+    format_pre_release_audit_report,
+    generate_pre_release_audit_report,
+)
 
 from .template_validation import (
     TemplateValidationCheck,
@@ -83,13 +179,70 @@ from .release_evidence import (
     run_release_evidence_validation,
 )
 
+from .project_config import (
+    PROJECT_CONFIG_FILENAME,
+    PROJECT_CONFIG_SCHEMA_VERSION,
+    ProjectConfig,
+    find_project_config,
+    load_project_config,
+)
+
+from .deprecation import (
+    HyperKitDeprecationWarning,
+    build_deprecation_message,
+    deprecated,
+    warn_deprecated,
+)
+
+from .environment import (
+    PlatformKind,
+    RuntimeEnvironment,
+    detect_platform,
+    detect_runtime_environment,
+)
+
+from .logging import (
+    configure_logging,
+    get_logger,
+    log_event,
+)
+
+from .lifecycle import (
+    run_game,
+    start_runtime,
+    stop_runtime,
+)
+
+from .api_contract import (
+    REQUIRED_PUBLIC_API,
+    get_missing_public_api,
+    validate_public_api,
+)
+
 
 try:  # Kivy may not be available in headless test environments.
     from .app import Game
 except Exception:  # pragma: no cover
     Game = None  # type: ignore
 
+
 __all__ = [
+    "API_VERSION",
+    "SDKConfig",
+    "RuntimeState",
+    "SDKContext",
+    "create_context",
+    "get_default_context",
+    "set_default_context",
+    "reset_default_context",
+    "HyperKitError",
+    "HyperKitConfigurationError",
+    "HyperKitCompatibilityError",
+    "HyperKitRuntimeError",
+    "HyperKitValidationError",
+    "get_api_version",
+    "is_api_compatible",
+    "require_api_version",
     "Button",
     "TextLabel",
     "Circle",
@@ -192,6 +345,29 @@ __all__ = [
     "format_release_evidence_report",
     "generate_release_evidence_report",
     "run_release_evidence_validation",
+    "PROJECT_CONFIG_FILENAME",
+    "PROJECT_CONFIG_SCHEMA_VERSION",
+    "ProjectConfig",
+    "find_project_config",
+    "load_project_config",
+    "HyperKitDeprecationWarning",
+    "build_deprecation_message",
+    "deprecated",
+    "warn_deprecated",
+    "PlatformKind",
+    "RuntimeEnvironment",
+    "detect_platform",
+    "detect_runtime_environment",
+    "configure_logging",
+    "get_logger",
+    "log_event",
+    "start_runtime",
+    "stop_runtime",
+    "run_game",
+    "REQUIRED_PUBLIC_API",
+    "get_missing_public_api",
+    "validate_public_api",
 ]
 
-__version__ = "0.1.2"
+
+__version__ = "0.2.0"

gameviz_hyperkit-0.2.0/src/hyperkit/api_contract.py

@@ -0,0 +1,101 @@
+"""Public API contract for GameViz HyperKit."""
+
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Optional
+
+from .errors import HyperKitCompatibilityError
+
+
+REQUIRED_PUBLIC_API = frozenset(
+    {
+        # Existing core game API
+        "Game",
+        "GameObject",
+        "Scene",
+        "SaveManager",
+        "ScoreManager",
+
+        # Phase 70
+        "API_VERSION",
+        "SDKConfig",
+        "HyperKitError",
+        "HyperKitConfigurationError",
+        "HyperKitCompatibilityError",
+        "HyperKitRuntimeError",
+        "HyperKitValidationError",
+        "get_api_version",
+        "is_api_compatible",
+        "require_api_version",
+
+        # Phase 71
+        "RuntimeState",
+        "SDKContext",
+        "create_context",
+        "get_default_context",
+        "set_default_context",
+        "reset_default_context",
+
+        # Phase 72
+        "PlatformKind",
+        "RuntimeEnvironment",
+        "detect_platform",
+        "detect_runtime_environment",
+        "configure_logging",
+        "get_logger",
+        "log_event",
+        "PROJECT_CONFIG_FILENAME",
+        "PROJECT_CONFIG_SCHEMA_VERSION",
+        "ProjectConfig",
+        "find_project_config",
+        "load_project_config",
+        "HyperKitDeprecationWarning",
+        "build_deprecation_message",
+        "deprecated",
+        "warn_deprecated",
+        "start_runtime",
+        "stop_runtime",
+        "run_game",
+    }
+)
+
+
+def get_missing_public_api(
+    namespace: Mapping[str, object],
+) -> tuple[str, ...]:
+    """Return required public API names missing from a namespace."""
+
+    missing = (
+        REQUIRED_PUBLIC_API
+        - set(namespace)
+    )
+
+    return tuple(
+        sorted(missing)
+    )
+
+
+def validate_public_api(
+    namespace: Optional[
+        Mapping[str, object]
+    ] = None,
+) -> None:
+    """Validate the HyperKit public API contract."""
+
+    if namespace is None:
+        import hyperkit
+
+        namespace = vars(hyperkit)
+
+    missing = get_missing_public_api(
+        namespace
+    )
+
+    if missing:
+        names = ", ".join(missing)
+
+        raise HyperKitCompatibilityError(
+            "HyperKit public API contract "
+            f"is missing: {names}."
+        )

gameviz_hyperkit-0.2.0/src/hyperkit/compatibility.py

@@ -0,0 +1,89 @@
+"""Public API compatibility helpers for GameViz HyperKit."""
+
+from __future__ import annotations
+
+from .errors import HyperKitCompatibilityError
+
+
+API_VERSION = "0.2"
+
+
+def _parse_api_version(version: str) -> tuple[int, int]:
+    """Parse a HyperKit API version in MAJOR.MINOR format."""
+
+    if not isinstance(version, str):
+        raise HyperKitCompatibilityError(
+            "HyperKit API version must be a string in MAJOR.MINOR format."
+        )
+
+    parts = version.strip().split(".")
+
+    if len(parts) != 2:
+        raise HyperKitCompatibilityError(
+            f"Invalid HyperKit API version '{version}'. "
+            "Expected MAJOR.MINOR format, for example '0.2'."
+        )
+
+    try:
+        major = int(parts[0])
+        minor = int(parts[1])
+    except ValueError as exc:
+        raise HyperKitCompatibilityError(
+            f"Invalid HyperKit API version '{version}'. "
+            "Major and minor versions must be integers."
+        ) from exc
+
+    if major < 0 or minor < 0:
+        raise HyperKitCompatibilityError(
+            "HyperKit API version values cannot be negative."
+        )
+
+    return major, minor
+
+
+def get_api_version() -> str:
+    """Return the current public HyperKit API version."""
+
+    return API_VERSION
+
+
+def is_api_compatible(required_version: str) -> bool:
+    """Return whether the current API satisfies a requested API version.
+
+    HyperKit uses major-version compatibility.
+
+    Within the same major version, a newer minor API is considered
+    compatible with an older requested minor API.
+
+    Examples for API version 0.2:
+
+        0.1 -> compatible
+        0.2 -> compatible
+        0.3 -> incompatible
+        1.0 -> incompatible
+    """
+
+    current_major, current_minor = _parse_api_version(API_VERSION)
+    required_major, required_minor = _parse_api_version(required_version)
+
+    return (
+        current_major == required_major
+        and current_minor >= required_minor
+    )
+
+
+def require_api_version(required_version: str) -> None:
+    """Require a compatible HyperKit API version.
+
+    Raises:
+        HyperKitCompatibilityError:
+            If the requested API is not compatible with this SDK.
+    """
+
+    if is_api_compatible(required_version):
+        return
+
+    raise HyperKitCompatibilityError(
+        f"HyperKit API {required_version} is required, "
+        f"but this SDK provides API {API_VERSION}."
+    )