scrollkit 0.8.3__tar.gz → 0.8.4__tar.gz

{scrollkit-0.8.3 → scrollkit-0.8.4}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+Copyright (c) 2024-2026 Michael Czeiszperger
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -25,7 +25,19 @@ SOFTWARE.
 This repository vendors third-party components that retain their own licenses
 and copyright notices; this MIT license does not supersede them:
 
-  - src/scrollkit/simulator/adafruit_display_text/ and adafruit_bitmap_font/ —
-    Adafruit Industries (MIT). See the SPDX headers in those files.
-  - Bundled fonts under src/scrollkit/simulator/ — various foundries under the
-    SIL Open Font License (OFL). See src/scrollkit/simulator/ATTRIBUTION.md.
+  - Bundled fonts under src/scrollkit/simulator/fonts/ — various foundries under
+    the SIL Open Font License (OFL). Each font ships with its own .license file;
+    see src/scrollkit/simulator/ATTRIBUTION.md.
+
+The desktop simulator provides API-compatible, clean-room reimplementations
+under Adafruit-matching names (e.g. src/scrollkit/simulator/adafruit_display_text/
+and adafruit_bitmap_font/) so that unmodified device code — which imports those
+module names — also runs on the desktop. These directories contain ScrollKit's
+own code, not Adafruit's, and are covered by the MIT license above. The
+corresponding Adafruit CircuitPython libraries are not redistributed here; they
+are installed separately onto the device.
+
+Acknowledgement: ScrollKit's over-the-air update feature was inspired by Ronald
+Dehuysser's micropython-ota-updater
+(https://github.com/rdehuyss/micropython-ota-updater). ScrollKit's OTA subsystem
+is its own manifest-based design and contains none of that project's code.

{scrollkit-0.8.3/src/scrollkit.egg-info → scrollkit-0.8.4}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: scrollkit
-Version: 0.8.3
+Version: 0.8.4
 Summary: LED Matrix Display Framework for CircuitPython and Desktop
-Author-email: Michael Winslow Czeiszperger <michael@czei.org>
+Author-email: Michael Czeiszperger <michael@czei.org>
 License: MIT
 Project-URL: Homepage, https://github.com/czei/scrollkit
 Project-URL: Repository, https://github.com/czei/scrollkit
@@ -243,6 +243,13 @@ voice, with my own screenshots. Yes, AI has touched a lot of this code. It was
 also directed by an engineer who has shipped production software for a living,
 including time on one of Sun Microsystems' API teams. Both are true.
 
+## Acknowledgements
+
+ScrollKit's over-the-air update feature was inspired by
+[Ronald Dehuysser's micropython-ota-updater](https://github.com/rdehuyss/micropython-ota-updater).
+The current implementation is ScrollKit's own manifest-based design and uses none
+of his code — but the idea came from his project, and it deserves the shout-out.
+
 ## License
 
 MIT

{scrollkit-0.8.3 → scrollkit-0.8.4}/README.md

@@ -199,6 +199,13 @@ voice, with my own screenshots. Yes, AI has touched a lot of this code. It was
 also directed by an engineer who has shipped production software for a living,
 including time on one of Sun Microsystems' API teams. Both are true.
 
+## Acknowledgements
+
+ScrollKit's over-the-air update feature was inspired by
+[Ronald Dehuysser's micropython-ota-updater](https://github.com/rdehuyss/micropython-ota-updater).
+The current implementation is ScrollKit's own manifest-based design and uses none
+of his code — but the idea came from his project, and it deserves the shout-out.
+
 ## License
 
 MIT

{scrollkit-0.8.3 → scrollkit-0.8.4}/pyproject.toml

@@ -4,13 +4,13 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "scrollkit"
-version = "0.8.3"
+version = "0.8.4"
 description = "LED Matrix Display Framework for CircuitPython and Desktop"
 readme = "README.md"
 requires-python = ">=3.8"
 license = {text = "MIT"}
 authors = [
-    {name = "Michael Winslow Czeiszperger", email = "michael@czei.org"}
+    {name = "Michael Czeiszperger", email = "michael@czei.org"}
 ]
 keywords = ["circuitpython", "led-matrix", "display", "matrixportal", "simulator"]
 classifiers = [

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """ScrollKit - LED Matrix Display Framework for CircuitPython and Desktop.
 
 A framework for building scrolling LED matrix applications that run unchanged on
@@ -13,4 +13,4 @@ need from submodules, e.g.::
     from scrollkit.display.unified import UnifiedDisplay
 """
 
-__version__ = "0.8.3"
+__version__ = "0.8.4"

scrollkit-0.8.4/src/scrollkit/app/__init__.py

@@ -0,0 +1,6 @@
+# Copyright (c) 2024-2026 Michael Czeiszperger
+"""ScrollKit Application framework."""
+
+from .base import SLDKApp, ScrollKitApp
+
+__all__ = ['SLDKApp', 'ScrollKitApp']

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/app/base.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Base application class for SLDK.
 
 Provides the three-process architecture with graceful degradation for ESP32.

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/app/memory.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Realistic free-RAM estimate shared by the run loop and the dev harness.
 
 The run loop gates optional processes on free RAM (data updates need ~20-30 KB,

scrollkit-0.8.4/src/scrollkit/config/__init__.py

@@ -0,0 +1 @@
+# Copyright (c) 2024-2026 Michael Czeiszperger

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/config/settings_manager.py

@@ -1,6 +1,6 @@
 """
 Settings manager for handling user configuration.
-Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+Copyright (c) 2024-2026 Michael Czeiszperger
 """
 import json
 

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/config/transition_names.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Canonical list of built-in transition names — the single source of truth.
 
 This module is **literal-only**: it imports nothing, so it is safe to import on

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/dev/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Desktop-only developer / AI-agent affordances for ScrollKit.
 
 Everything here exists to help a human or an AI agent build and *verify* a

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/dev/capabilities.py

@@ -1,11 +1,13 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Machine-readable catalog of what a ScrollKit app can use — for AI authoring.
 
 ``capabilities()`` returns a JSON-able dict describing the building blocks an
 agent should reach for when writing an app: the panel geometry, the content
-types and their constructor parameters, priority levels, available effects,
-named colors, and the display drawing API — plus a pointer at the headless
-verification loop.
+types and their constructor parameters, priority levels, the effect categories
+(standalone splash/particle ``effects``, content-swap ``transitions``,
+``scrolling`` presentations, BitmapText ``palette_effects``, and the
+``image_animators`` that decorate a static image), named colors, and the display
+drawing API — plus a pointer at the headless verification loop.
 
 Everything is **introspected from live code** (the real ``Priority`` class, the
 ``effects`` package's ``__all__``, ``NAMED_COLORS``, the
@@ -147,6 +149,27 @@ def _effects():
     return out
 
 
+def _image_animators():
+    """``[{name, doc, feasibility}]`` for the per-frame image-layer animators.
+
+    Its OWN category — these decorate a *static image already on screen* via the
+    start/step/detach contract, distinct from the content-swap ``transitions`` and from
+    the standalone splash/particle ``effects``. Enumerated via the module's explicit
+    ``ANIMATOR_CLASSES`` catalog (not ``__subclasses__``) so the order is stable and the
+    base ``IntroAnimator`` scaffolding is excluded. No ``pairs_with`` — they attach to an
+    image, not to text presentations; ``feasibility`` is each class's FEASIBILITY budget.
+    """
+    out = []
+    try:
+        from ..effects.image_animators import ANIMATOR_CLASSES
+    except ImportError:
+        return out
+    for cls in ANIMATOR_CLASSES:
+        out.append({"name": cls.__name__, "doc": _first_line(cls),
+                    "feasibility": getattr(cls, "FEASIBILITY", None)})
+    return out
+
+
 def _transitions():
     """``[{name, doc, feasibility, pairs_with}]`` for the built-in content-swap transitions.
 
@@ -299,6 +322,7 @@ def capabilities():
     for key, fn in (("content_types", _content_types), ("priorities", _priorities),
                     ("effects", _effects), ("transitions", _transitions),
                     ("scrolling", _scrolling), ("palette_effects", _palette_effects),
+                    ("image_animators", _image_animators),
                     ("text_fills", _text_fills), ("color_utilities", _color_utilities),
                     ("named_colors", _named_colors),
                     ("display_api", _display_api), ("hardware", _hardware),
@@ -356,6 +380,14 @@ def as_text(cat=None):
         lines.append("Palette effects (on BitmapText):")
         for e in pe:
             lines.append("  - %s%s — %s" % (e["name"], _pairs(e), e["doc"]))
+    ia = cat.get("image_animators")
+    if isinstance(ia, list) and ia:
+        lines.append("Image animators (decorate a static image on screen):")
+        for e in ia:
+            feas = e.get("feasibility") or {}
+            ms = feas.get("modeled_frame_ms")
+            budget = " (~%sms/frame)" % ms if ms is not None else ""
+            lines.append("  - %s%s — %s" % (e["name"], budget, e["doc"]))
     tf = cat.get("text_fills")
     if isinstance(tf, dict) and isinstance(tf.get("gradient"), dict):
         g = tf["gradient"]

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/dev/harness.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Headless verification harness — the AI agent's primary tool.
 
 ``run_headless(app, frames=N)`` drives a ``ScrollKitApp``'s display loop

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/dev/metrics.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Pixel-level metrics for headless verification (desktop-only, numpy).
 
 Reads the simulator's true-color RGB888 buffer

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/dev/performance.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Measured performance trade-offs for the MatrixPortal S3 — for AI authoring.
 
 Turns the raw microbenchmark table (``simulator/core/device_benchmarks.json``,

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/dev/validation.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Pre-flight validation for a ScrollKit app — structured issues with fixes.
 
 ``validate(app)`` runs the app headless once and combines *static* checks on its

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """ScrollKit Display module.
 
 Kept lean on purpose: importing this package pulls in only the core content

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/_graphics.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Shared display-graphics primitives (mixed into Simulator + Unified displays).
 
 One code path, both platforms. Provides:

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/_recording.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Desktop-only frame capture + encoding for the display recording API.
 
 The user-facing methods (``start_recording`` / ``save_gif`` / ``save_video`` /

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/_sim_backend.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Shared desktop-simulator backend setup for the two display classes.
 
 ``UnifiedDisplay`` (the production entry point, which auto-selects hardware vs

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/bitmap_text.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Palette-animated bitmap text (Class 3 — the proving spike for the foundation).
 
 A ScrollKit-native fixed-cell 5x7 font is rendered ONCE into an indexed Bitmap

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/boards.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Board registry: how ScrollKit builds a panel on each supported board.
 
 ScrollKit runs the *same* app on more than one HUB75 driver board. The boards

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/colors.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Continuous 24-bit colour generators (device-safe, pure-integer math).
 
 These expose the **full** colour space as functions an app or effect samples at any

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/content.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Display content classes for SLDK.
 
 Provides base classes and implementations for displayable content.

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/gradient_text.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Static directional gradient / palette text fill (indexed-bitmap renderer).
 
 When ``StaticText`` / ``ScrollingText`` are given a ``palette``, their glyphs are

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/interface.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Display interface for SLDK.
 
 This provides the abstract interface that all display implementations must follow.

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/simulator.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Simulator display for SLDK — the interactive desktop entry point.
 
 ``SimulatorDisplay`` IS ``UnifiedDisplay`` (one per-frame pipeline: the same

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/text_fill.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Shared vocabulary for gradient text fills (the live source of truth).
 
 Kept deliberately tiny and dependency-free (pure constants + functions, no

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/text_pixels.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Font/scale-aware text → lit-pixel composition (single source of truth).
 
 ``pixels_from_font_text`` renders a string with *any* loaded font at an integer

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/display/unified.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Unified display implementation for SLDK.
 
 Provides a unified interface that works on both CircuitPython hardware

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/effects/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """ScrollKit Effects package.
 
 Kept deliberately empty of imports: importing ``scrollkit.effects`` must not
@@ -18,6 +18,10 @@ into RAM. Import each submodule directly instead:
   ``from scrollkit.effects.swarm_reveal import show_swarm_splash, SwarmReveal``
 - **Particles** —
   ``from scrollkit.effects.particles import ParticleEngine, Sparkle, Snow``
+- **Image animators** (per-frame motion layered onto a static image already on
+  screen — start/step/detach, not the ``Transition`` contract) —
+  ``from scrollkit.effects.image_animators import TwinkleAnimator, MotionAnimator,
+  ComboAnimator``
 - **Text-rendering helpers** —
   ``from scrollkit.effects.text_render import pixels_from_font_text, font_text_width``
 

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/effects/drip_splash.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Drip-splash animation — LEDs drip in from an edge (default the top) into place.
 
 The inverse of :func:`scrollkit.effects.show_reveal_splash`.  The screen starts

{scrollkit-0.8.3 → scrollkit-0.8.4}/src/scrollkit/effects/easing.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+# Copyright (c) 2024-2026 Michael Czeiszperger
 """Integer easing/tween lookup tables (CircuitPython-safe).
 
 Each named curve is a length-256 ``bytes`` table mapping a 0..255 progress to a