gamepulse-core 0.1.0__py3-none-any.whl

gamepulse_core/__init__.py

@@ -0,0 +1,51 @@
+from gamepulse_core.enums import EventCategory, Platform, SessionEndReason, Severity
+from gamepulse_core.events import (
+    BaseEvent,
+    CrashEvent,
+    CurrencyEarnEvent,
+    CurrencySpendEvent,
+    CustomEvent,
+    GameplayEvent,
+    LevelCompleteEvent,
+    LevelFailEvent,
+    LevelStartEvent,
+    SessionEndEvent,
+    SessionStartEvent,
+)
+from gamepulse_core.schemas import (
+    BatchEventsRequest,
+    BatchEventsResponse,
+    CrashIngestRequest,
+    IdentifyPlayerRequest,
+    SessionEndRequest,
+    SessionStartRequest,
+    SessionStartResponse,
+)
+from gamepulse_core.version import SCHEMA_VERSION, __version__
+
+__all__ = [
+    "BaseEvent",
+    "BatchEventsRequest",
+    "BatchEventsResponse",
+    "CrashEvent",
+    "CrashIngestRequest",
+    "CurrencyEarnEvent",
+    "CurrencySpendEvent",
+    "CustomEvent",
+    "EventCategory",
+    "GameplayEvent",
+    "IdentifyPlayerRequest",
+    "LevelCompleteEvent",
+    "LevelFailEvent",
+    "LevelStartEvent",
+    "Platform",
+    "SCHEMA_VERSION",
+    "SessionEndEvent",
+    "SessionEndReason",
+    "SessionEndRequest",
+    "SessionStartEvent",
+    "SessionStartRequest",
+    "SessionStartResponse",
+    "Severity",
+    "__version__",
+]

gamepulse_core/constants.py

@@ -0,0 +1,11 @@
+API_KEY_HEADER = "X-GamePulse-Key"
+PROJECT_HEADER = "X-GamePulse-Project"
+REQUEST_ID_HEADER = "X-Request-ID"
+
+DEFAULT_BATCH_SIZE = 50
+DEFAULT_FLUSH_INTERVAL_S = 2.0
+MAX_BATCH_SIZE = 500
+MAX_PAYLOAD_BYTES = 256 * 1024
+
+DEFAULT_SESSION_TIMEOUT_S = 30 * 60
+DEFAULT_HEARTBEAT_INTERVAL_S = 60

gamepulse_core/enums.py

@@ -0,0 +1,38 @@
+from enum import Enum
+
+
+class EventCategory(str, Enum):
+    SYSTEM = "system"
+    PROGRESSION = "progression"
+    ECONOMY = "economy"
+    GAMEPLAY = "gameplay"
+    SOCIAL = "social"
+    ERROR = "error"
+    CUSTOM = "custom"
+
+
+class Platform(str, Enum):
+    WINDOWS = "windows"
+    MACOS = "macos"
+    LINUX = "linux"
+    IOS = "ios"
+    ANDROID = "android"
+    WEB = "web"
+    CONSOLE = "console"
+    UNKNOWN = "unknown"
+
+
+class Severity(str, Enum):
+    DEBUG = "debug"
+    INFO = "info"
+    WARNING = "warning"
+    ERROR = "error"
+    FATAL = "fatal"
+
+
+class SessionEndReason(str, Enum):
+    NORMAL = "normal"
+    CRASH = "crash"
+    RAGE_QUIT = "rage_quit"
+    TIMEOUT = "timeout"
+    BACKGROUND = "background"

gamepulse_core/events.py

@@ -0,0 +1,103 @@
+from __future__ import annotations
+
+from datetime import UTC, datetime
+from typing import Any
+from uuid import UUID, uuid4
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from gamepulse_core.enums import EventCategory, SessionEndReason, Severity
+
+
+def _utcnow() -> datetime:
+    return datetime.now(UTC)
+
+
+class BaseEvent(BaseModel):
+    """Wire-format event. SDK constructs these; API validates them."""
+
+    model_config = ConfigDict(use_enum_values=True, extra="forbid")
+
+    event_id: UUID = Field(default_factory=uuid4)
+    type: str
+    category: EventCategory
+    name: str
+    occurred_at: datetime = Field(default_factory=_utcnow)
+    session_id: UUID | None = None
+    player_id: str | None = None
+    payload: dict[str, Any] = Field(default_factory=dict)
+    sdk_version: str | None = None
+
+
+# ---------- System ----------
+
+class SessionStartEvent(BaseEvent):
+    category: EventCategory = EventCategory.SYSTEM
+    type: str = "system.session_start"
+    name: str = "session_start"
+
+
+class SessionEndEvent(BaseEvent):
+    category: EventCategory = EventCategory.SYSTEM
+    type: str = "system.session_end"
+    name: str = "session_end"
+    end_reason: SessionEndReason = SessionEndReason.NORMAL
+
+
+# ---------- Progression ----------
+
+class LevelStartEvent(BaseEvent):
+    category: EventCategory = EventCategory.PROGRESSION
+    type: str = "progression.level_start"
+    name: str = "level_start"
+
+
+class LevelCompleteEvent(BaseEvent):
+    category: EventCategory = EventCategory.PROGRESSION
+    type: str = "progression.level_complete"
+    name: str = "level_complete"
+
+
+class LevelFailEvent(BaseEvent):
+    category: EventCategory = EventCategory.PROGRESSION
+    type: str = "progression.level_fail"
+    name: str = "level_fail"
+
+
+# ---------- Economy ----------
+
+class CurrencyEarnEvent(BaseEvent):
+    category: EventCategory = EventCategory.ECONOMY
+    type: str = "economy.currency_earn"
+    name: str = "currency_earn"
+
+
+class CurrencySpendEvent(BaseEvent):
+    category: EventCategory = EventCategory.ECONOMY
+    type: str = "economy.currency_spend"
+    name: str = "currency_spend"
+
+
+# ---------- Gameplay ----------
+
+class GameplayEvent(BaseEvent):
+    category: EventCategory = EventCategory.GAMEPLAY
+    type: str = "gameplay.action"
+    name: str = "action"
+
+
+# ---------- Errors ----------
+
+class CrashEvent(BaseEvent):
+    category: EventCategory = EventCategory.ERROR
+    type: str = "error.crash"
+    name: str = "crash"
+    severity: Severity = Severity.ERROR
+
+
+# ---------- Custom ----------
+
+class CustomEvent(BaseEvent):
+    category: EventCategory = EventCategory.CUSTOM
+    type: str = "custom.event"
+    name: str = "event"

gamepulse_core/schemas.py

@@ -0,0 +1,79 @@
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from gamepulse_core.constants import MAX_BATCH_SIZE
+from gamepulse_core.enums import Platform, SessionEndReason, Severity
+from gamepulse_core.events import BaseEvent
+
+
+class DeviceContext(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
+    platform: Platform = Platform.UNKNOWN
+    os_version: str | None = None
+    locale: str | None = None
+    python_version: str | None = None
+    app_version: str | None = None
+
+
+# ---------- Players ----------
+
+class IdentifyPlayerRequest(BaseModel):
+    external_id: str
+    country: str | None = None
+    platform: Platform | None = None
+    app_version: str | None = None
+    attributes: dict[str, Any] = Field(default_factory=dict)
+
+
+# ---------- Sessions ----------
+
+class SessionStartRequest(BaseModel):
+    player_external_id: str
+    started_at: datetime
+    device: DeviceContext = Field(default_factory=DeviceContext)
+    app_version: str | None = None
+
+
+class SessionStartResponse(BaseModel):
+    session_id: UUID
+    player_id: UUID
+
+
+class SessionEndRequest(BaseModel):
+    session_id: UUID
+    ended_at: datetime
+    end_reason: SessionEndReason = SessionEndReason.NORMAL
+
+
+# ---------- Events ----------
+
+class BatchEventsRequest(BaseModel):
+    player_external_id: str
+    events: list[BaseEvent] = Field(..., max_length=MAX_BATCH_SIZE)
+    device: DeviceContext | None = None
+
+
+class BatchEventsResponse(BaseModel):
+    accepted: int
+    rejected: int = 0
+    duplicates: int = 0
+
+
+# ---------- Crashes ----------
+
+class CrashIngestRequest(BaseModel):
+    player_external_id: str
+    session_id: UUID | None = None
+    fingerprint: str
+    exc_type: str
+    message: str | None = None
+    stacktrace: str
+    severity: Severity = Severity.ERROR
+    occurred_at: datetime
+    context: dict[str, Any] = Field(default_factory=dict)

gamepulse_core/version.py

@@ -0,0 +1,2 @@
+__version__ = "0.1.0"
+SCHEMA_VERSION = "1"

gamepulse_core-0.1.0.dist-info/METADATA

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: gamepulse-core
+Version: 0.1.0
+Summary: Shared Pydantic models, enums, and schemas for the GamePulse analytics platform
+Project-URL: Homepage, https://github.com/ronkochba2004-pixel/GamePulse-SDK
+Project-URL: Repository, https://github.com/ronkochba2004-pixel/GamePulse-SDK
+Project-URL: Bug Tracker, https://github.com/ronkochba2004-pixel/GamePulse-SDK/issues
+Author-email: Ron Kochba <ronkochba2004@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: analytics,game-analytics,pydantic,schemas
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.7
+Description-Content-Type: text/markdown
+
+# gamepulse-core
+
+Shared Pydantic models, enums, and schemas for the [GamePulse](https://github.com/ronkochba2004-pixel/GamePulse-SDK) analytics platform.
+
+This package contains the wire-format types used by both the GamePulse API and the GamePulse Python SDK. It is an internal dependency — if you are integrating GamePulse into your game, install `gamepulse-sdk` instead.
+
+```bash
+pip install gamepulse-sdk
+```
+
+## Contents
+
+- **`gamepulse_core.events`** — Pydantic event models (`BaseEvent`, `LevelStartEvent`, `CurrencySpendEvent`, …)
+- **`gamepulse_core.schemas`** — HTTP request/response schemas (`BatchEventsRequest`, `SessionStartRequest`, …)
+- **`gamepulse_core.enums`** — `EventCategory`, `Platform`, `SessionEndReason`, `Severity`
+- **`gamepulse_core.constants`** — API header names, limits, flush defaults
+- **`gamepulse_core.version`** — `__version__`, `SCHEMA_VERSION`
+
+## Links
+
+- [GitHub repository](https://github.com/ronkochba2004-pixel/GamePulse-SDK)
+- [SDK package (gamepulse-sdk)](https://pypi.org/project/gamepulse-sdk/)

gamepulse_core-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+gamepulse_core/__init__.py,sha256=Wdkstn_y09zFNySyJvjDTeJFsiU9oQzu0w5iTtPMF0E,1188
+gamepulse_core/constants.py,sha256=AdoiBqZTsDQgfKUsd4XU7m239oq8byymihzenzqvQRo,288
+gamepulse_core/enums.py,sha256=BsQdtZKWWZKeW2juPD02RF872_60G1HQtWQszhKiqSY,713
+gamepulse_core/events.py,sha256=FIW3mfNPE8z0bzZvzR0sTz8sBagO298o8fl1PBYCEHo,2662
+gamepulse_core/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gamepulse_core/schemas.py,sha256=ubCo5gNH3fdMRUSLwoL7sTa5oY1y2zeVhMlCkFYMofU,1958
+gamepulse_core/version.py,sha256=tccfbRdS-r3tzqJkmI51j1KU7w551tr05kCCGLBQgMo,43
+gamepulse_core-0.1.0.dist-info/METADATA,sha256=vGYJbl4ttFIar65HlwCjCdA32vvc45MlwP_Itu2ZAUc,2165
+gamepulse_core-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+gamepulse_core-0.1.0.dist-info/licenses/LICENSE,sha256=K3S2q5q96K8Hynhsgw6r-J_5-M2y5zO8Kcvet6uAEqI,1067
+gamepulse_core-0.1.0.dist-info/RECORD,,

gamepulse_core-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

gamepulse_core-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ron Kochba
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.