matrixrender 0.1.0__tar.gz

matrixrender-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 General Software Development
+
+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.

matrixrender-0.1.0/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: matrixrender
+Version: 0.1.0
+Summary: Turn a numpy matrix into a rendered screen via PyGame
+License: MIT
+License-File: LICENSE
+Author: Sandu Bogdan
+Author-email: bogdanelsandu@hotmail.com
+Requires-Python: >=3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: numpy (>=2.4.1,<3.0.0)
+Requires-Dist: pygame (>=2.6.1,<3.0.0)
+Description-Content-Type: text/markdown
+
+

matrixrender-0.1.0/matrixrender/__init__.py

@@ -0,0 +1 @@
+from . import render as render

matrixrender-0.1.0/matrixrender/render.py

@@ -0,0 +1,111 @@
+import pygame
+import numpy as np
+import typing as ttypes
+
+class WindowExitRequested(BaseException): ...
+
+class App:
+    def __init__(self, screen: pygame.Surface, clock: pygame.time.Clock, zoom: int = 1, target_fps: int = 60):
+        self.screen = screen
+        self.clock = clock
+        self.zoom = zoom
+        self.target_fps = target_fps
+        self.__width =  int(self.screen.get_width() / zoom)
+        self.__height = int(self.screen.get_height() / zoom)
+        self.__delta_time: float = 1.0 / target_fps
+
+    def tick(self):
+        self.__delta_time = float(self.clock.tick(self.target_fps)) / 1000
+
+    @property
+    def width(self): return self.__width
+
+    @property
+    def height(self): return self.__height
+
+    @property
+    def dt(self) -> float:
+        return min(self.__delta_time, 0.25)  # Clamp at 4 FPS
+    
+    def clear_events(self):
+        for event in pygame.event.get():
+            yield event
+
+class State:
+    def __init__(self, width: int, height: int):
+        self.x_max = width
+        self.y_max = height
+
+        # State.area usage:
+        # State.area[x, y]
+        #
+        # or (not recommended as it is slower): State.area[x][y]
+        self.area = np.zeros((self.x_max, self.y_max), dtype=int)
+
+    def set_area(self, area: np.ndarray) -> None:
+        if area.shape != self.area.shape:
+            raise ValueError("Area shape mismatch")
+        
+        self.area = area
+
+    def set_cell(self, x: int, y: int, value: int) -> None:
+        self.area[x, y] = value
+
+def init_screen(width=800, height=600, title="Pygame Window", zoom: int = 1, target_fps: int = 60) -> App:
+    pygame.init()
+    
+    screen = pygame.display.set_mode((width * zoom, height * zoom))
+    pygame.display.set_caption(title)
+    
+    clock = pygame.time.Clock()
+    
+    return App(screen, clock, zoom, target_fps)
+
+def _draw_cell(
+    screen: pygame.Surface,
+    x: int,
+    y: int,
+    color: pygame.Color,
+    cell_size: int,
+) -> None:
+    rect = pygame.Rect(
+        x * cell_size,
+        y * cell_size,
+        cell_size,
+        cell_size,
+    )
+    pygame.draw.rect(screen, color, rect)
+
+WHITE: pygame.Color = pygame.Color(255, 255, 255, 255)
+BLACK: pygame.Color = pygame.Color( 0,   0,   0,  255)
+_states = {0: WHITE}
+
+def register_state(value: int, color: pygame.Color) -> None:
+    _states[value] = color
+
+def update_screen(app: App, state: State) -> tuple[bool, ttypes.Optional[Exception]]:
+    # If types don't correspond, raise Error as the caller is possibly in an invalid state
+    #
+    # If drawing fails, simply return the Error so the caller can understand what went wrong
+    # and handle the error / do cleanup
+
+    if (not isinstance(app, App)):
+        raise TypeError("app is not an instance of type App().")
+    elif (not isinstance(state, State)):
+        raise TypeError("state is not an instance of type State().")
+    
+    app.screen.fill(BLACK)
+    
+    for i in range(0, state.x_max):
+        for j in range(0, state.y_max):
+            _draw_cell(app.screen, i, j, _states.get(state.area[i, j], BLACK), app.zoom)
+
+    if pygame.event.peek(pygame.QUIT):
+        raise WindowExitRequested("User closed the PyGame window.")
+
+    try:
+        pygame.display.flip()
+        app.tick()
+        return (True, None)
+    except Exception as e:
+        return (False, e)

matrixrender-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[project]
+name = "matrixrender"
+version = "0.1.0"
+description = "Turn a numpy matrix into a rendered screen via PyGame"
+authors = [
+    {name = "Sandu Bogdan",email = "bogdanelsandu@hotmail.com"}
+]
+license = {text = "MIT License"}
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "numpy (>=2.4.1,<3.0.0)",
+    "pygame (>=2.6.1,<3.0.0)"
+]
+
+[dependency-groups]
+dev = [
+    "ruff (>=0.14.14,<0.15.0)",
+    "mypy (>=1.19.1,<2.0.0)"
+]
+
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"