gh-space-shooter 0.0.4__py3-none-any.whl → 1.0.0__py3-none-any.whl

gh_space_shooter/cli.py

@@ -60,6 +60,16 @@ def main(
         "--fps",
         help="Frames per second for the animation",
     ),
+    maxFrame: int | None = typer.Option(
+        None,
+        "--max-frame",
+        help="Maximum number of frames to generate",
+    ),
+    watermark: bool = typer.Option(
+        False,
+        "--watermark",
+        help="Add watermark to the GIF",
+    ),
 ) -> None:
     """
     Fetch or load GitHub contribution graph data and display it.
@@ -95,7 +105,7 @@ def main(
             _save_data_to_file(data, raw_output)
 
         # Generate GIF if requested
-        _generate_gif(data, out, strategy, fps)
+        _generate_gif(data, out, strategy, fps, watermark, maxFrame)
 
     except CLIError as e:
         err_console.print(f"[bold red]Error:[/bold red] {e}")
@@ -151,7 +161,14 @@ def _save_data_to_file(data: ContributionData, file_path: str) -> None:
         raise CLIError(f"Failed to save file '{file_path}': {e}")
 
 
-def _generate_gif(data: ContributionData, file_path: str, strategy_name: str, fps: int) -> None:
+def _generate_gif(
+    data: ContributionData, 
+    file_path: str, 
+    strategy_name: str, 
+    fps: int, 
+    watermark: bool, 
+    maxFrame: int | None
+) -> None:
     """Generate animated GIF visualization."""
     # GIF format limitation: delays below 20ms (>50 FPS) are clamped by most browsers
     if fps > 50:
@@ -174,8 +191,12 @@ def _generate_gif(data: ContributionData, file_path: str, strategy_name: str, fp
 
     # Create animator and generate GIF
     try:
-        animator = Animator(data, strategy, fps=fps)
-        animator.generate_gif(file_path)
+        animator = Animator(data, strategy, fps=fps, watermark=watermark)
+        buffer = animator.generate_gif(maxFrame=maxFrame)
+        console.print("[bold blue]Saving GIF animation...[/bold blue]")
+        with open(file_path, "wb") as f:
+            f.write(buffer.getvalue())
+
         console.print(f"[green]✓[/green] GIF saved to {file_path}")
     except Exception as e:
         raise CLIError(f"Failed to generate GIF: {e}")

gh_space_shooter/game/animator.py

@@ -1,10 +1,10 @@
 """Animator for generating GIF animations from game strategies."""
 
+from io import BytesIO
 from typing import Iterator
 
 from PIL import Image
 
-
 from ..github_client import ContributionData
 from .game_state import GameState
 from .renderer import Renderer
@@ -20,6 +20,7 @@ class Animator:
         contribution_data: ContributionData,
         strategy: BaseStrategy,
         fps: int,
+        watermark: bool = False,
     ):
         """
         Initialize animator.
@@ -28,16 +29,18 @@ class Animator:
             contribution_data: The GitHub contribution data
             strategy: The strategy to use for clearing enemies
             fps: Frames per second for the animation
+            watermark: Whether to add watermark to the GIF
         """
         self.contribution_data = contribution_data
         self.strategy = strategy
         self.fps = fps
+        self.watermark = watermark
         self.frame_duration = 1000 // fps
         # Delta time in seconds per frame
         # Used to scale all speeds (cells/second) to per-frame movement
         self.delta_time = 1.0 / fps
 
-    def generate_gif(self, output_path: str) -> None:
+    def generate_gif(self, maxFrame: int | None) -> BytesIO:
         """
         Generate animated GIF and save to file.
 
@@ -46,20 +49,27 @@ class Animator:
         """
         # Initialize game state
         game_state = GameState(self.contribution_data)
-        renderer = Renderer(game_state, RenderContext.darkmode())
+        renderer = Renderer(game_state, RenderContext.darkmode(), watermark=self.watermark)
 
-        frames = self._generate_frames(game_state, renderer)
+        frames: list[Image.Image] = []
+        for frame in self._generate_frames(game_state, renderer):
+            frames.append(frame)
+            if maxFrame is not None and len(frames) >= maxFrame:
+                break
 
-        # Save as GIF
+        gif_buffer = BytesIO()
         if frames:
-            next(frames).save(
-                output_path,
+            frames[0].save(
+                gif_buffer,
+                format="gif",
                 save_all=True,
-                append_images=list(frames),
+                append_images=frames[1:],
                 duration=self.frame_duration,
                 loop=0,  # Loop forever
                 optimize=False,
             )
+        
+        return gif_buffer
 
     def _generate_frames(
         self, game_state: GameState, renderer: Renderer

gh_space_shooter/game/renderer.py

@@ -1,24 +1,28 @@
 """Renderer for drawing game frames using Pillow."""
 
-from PIL import Image, ImageDraw
+from PIL import Image, ImageDraw, ImageFont
 
 from ..constants import NUM_WEEKS, SHIP_POSITION_Y
 from .game_state import GameState
 from .render_context import RenderContext
 
+WATERMARK_TEXT = "by czl9707/gh-space-shooter"
+
+
 class Renderer:
     """Renders game state as PIL Images."""
-    def __init__(self, game_state: GameState, render_context: RenderContext):
+    def __init__(self, game_state: GameState, render_context: RenderContext, watermark: bool = False):
         """
         Initialize renderer.
 
         Args:
             game_state: The game state to render
             render_context: Rendering configuration and theming
+            watermark: Whether to add watermark to frames
         """
         self.game_state = game_state
-
         self.context = render_context
+        self.watermark = watermark
 
         self.grid_width = NUM_WEEKS * (self.context.cell_size + self.context.cell_spacing)
         self.grid_height = SHIP_POSITION_Y * (self.context.cell_size + self.context.cell_spacing)
@@ -34,11 +38,33 @@ class Renderer:
         """
         # Create image with background color
         img = Image.new("RGB", (self.width, self.height), self.context.background_color)
-        
+
         # Draw game state
         overlay = Image.new("RGBA", (self.width, self.height), (0, 0, 0, 0))
         draw = ImageDraw.Draw(overlay, "RGBA")
         self.game_state.draw(draw, self.context)
+
+        # Draw watermark if enabled
+        if self.watermark:
+            self._draw_watermark(draw)
+
         combined = Image.alpha_composite(img.convert("RGBA"), overlay)
-        
+
         return combined.convert("RGB").convert("P", palette=Image.Palette.ADAPTIVE)
+
+    def _draw_watermark(self, draw: ImageDraw.ImageDraw) -> None:
+        """Draw watermark text in the bottom-right corner."""
+        font = ImageFont.load_default()
+        color = (100, 100, 100, 128)  # Semi-transparent gray
+        margin = 5
+
+        # Get text bounding box
+        bbox = draw.textbbox((0, 0), WATERMARK_TEXT, font=font)
+        text_width = bbox[2] - bbox[0]
+        text_height = bbox[3] - bbox[1]
+
+        # Position in bottom-right corner
+        x = self.width - text_width - margin
+        y = self.height - text_height - margin
+
+        draw.text((x, y), WATERMARK_TEXT, font=font, fill=color)

gh_space_shooter/github_client.py

@@ -122,7 +122,7 @@ class GitHubClient:
         if "errors" in data:
             errors = data["errors"]
             error_messages = [error.get("message", str(error)) for error in errors]
-            raise GitHubAPIError(f"GraphQL errors: {', '.join(error_messages)}")
+            raise GitHubAPIError(', '.join(error_messages))
 
         # Check if user exists
         if not data.get("data", {}).get("user"):

{gh_space_shooter-0.0.4.dist-info → gh_space_shooter-1.0.0.dist-info}/METADATA

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: gh-space-shooter
-Version: 0.0.4
+Version: 1.0.0
 Summary: A CLI tool that visualizes GitHub contribution graphs as gamified GIFs
 Author-email: zane <czl970721@gmail.com>
 License-File: LICENSE
-Requires-Python: >=3.13
+Requires-Python: >=3.12
 Requires-Dist: httpx>=0.27.0
 Requires-Dist: pillow>=10.1.0
 Requires-Dist: python-dotenv>=1.0.0
@@ -22,6 +22,10 @@ Transform your GitHub contribution graph into an epic space shooter game!
 
 ## Usage
 
+### Onetime Generation
+
+A [web interface](https://gh-space-shooter.kiyo-n-zane.com) is available for on-demand GIF generation without installing anything locally. 
+
 ### GitHub Action
 
 Automatically update your game GIF daily using GitHub Actions! Add this workflow to your repository at `.github/workflows/update-game.yml`:
@@ -122,14 +126,15 @@ gh-space-shooter torvalds --output my-epic-game.gif
 gh-space-shooter torvalds -o my-game.gif
 
 # Choose enemy attack strategy
-gh-space-shooter torvalds --strategy column   # Enemies attack in columns
 gh-space-shooter torvalds --strategy row      # Enemies attack in rows
 gh-space-shooter torvalds -s random           # Random chaos (default)
 
 # Adjust animation frame rate
-gh-space-shooter torvalds --fps 25            # Slower, smaller file size
-gh-space-shooter torvalds --fps 40            # Default frame rate
-gh-space-shooter torvalds --fps 50            # Smoother animation
+gh-space-shooter torvalds --fps 25            # Lower Frame rate, Smaller file size
+gh-space-shooter torvalds --fps 40            # Default Frame rate, Larger file size
+
+# Stop the animation earlier
+gh-space-shooter torvalds --max-frame 200     # Stop after 200 frames
 ```
 
 This creates an animated GIF showing:

{gh_space_shooter-0.0.4.dist-info → gh_space_shooter-1.0.0.dist-info}/RECORD

@@ -1,14 +1,14 @@
 gh_space_shooter/__init__.py,sha256=jBFfHY3YC8-3m-eVPIo3CWoQLsy5Yvd0vcbHVbUDTWY,337
-gh_space_shooter/cli.py,sha256=mCo7PH0XGCeGG9V6lCPlZMCmDIapeJVCfJenQgEW9o8,5798
+gh_space_shooter/cli.py,sha256=jmMwTGA_Xq80vBdWOurv6wcksmke6mtrHNBm9LQUpRQ,6340
 gh_space_shooter/console_printer.py,sha256=opT5vITkPJ_9BCPNMDays6EtXez9m86YXY9pK5_Hdh8,2345
 gh_space_shooter/constants.py,sha256=jMEaDAO1xdo9Bu4SN0vcOZfoESl3IAfF8r8OS8CSuwM,1399
-gh_space_shooter/github_client.py,sha256=PkXGWjR7TpzJvCPg37RM4kPq1phg_MlyBpHNtofaNXQ,4697
+gh_space_shooter/github_client.py,sha256=tR2yeDCvq2i5XE1_QvVXcd1S9qzo2AuK8HHJ9gfK6Mw,4676
 gh_space_shooter/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gh_space_shooter/game/__init__.py,sha256=bIc-S0hOiYqYBtdmd9_CedqYY07Il6XiV__TqcbtJNA,707
-gh_space_shooter/game/animator.py,sha256=G9PGcIQkdPgxByIKC1vlFnVHNdvTNefinXYj1_TEIMo,3126
+gh_space_shooter/game/animator.py,sha256=k0BTcWFlKq3fUi9hVn2f0btMakbgn8CZEMGvs8un9tg,3540
 gh_space_shooter/game/game_state.py,sha256=s-aQ-XvL4ybeu7q1Dhmd5tngC6fIMVbEBGrDtp6ELME,2949
 gh_space_shooter/game/render_context.py,sha256=TPJw9RmRB0_786W-O7nfB61UoDzDT_SlEVdaSlW750c,1805
-gh_space_shooter/game/renderer.py,sha256=J13eUOWHkImtiNWGyvRqORM7ngg1Q7LBUgs4cWFl26g,1617
+gh_space_shooter/game/renderer.py,sha256=JQLTDlI5GLeXCBQUeQdBwOh3xfGAr6kfmVwbdZvEEdk,2509
 gh_space_shooter/game/drawables/__init__.py,sha256=lzo3O5cxahrYTyOQVrz7rQ3Prkaj8Z_dpzlt0UdurOo,306
 gh_space_shooter/game/drawables/bullet.py,sha256=GTWDD0YqJ6cVlXBVFGNB_TPf0FV_J5Drmw23Fx_VpdE,3100
 gh_space_shooter/game/drawables/drawable.py,sha256=JjPnzpTnaRvKHYiQVCLOiq0zHjR8rOo7jqf6bKu5cKo,847
@@ -21,8 +21,8 @@ gh_space_shooter/game/strategies/base_strategy.py,sha256=IwPdthCWkgsFdUsMjQgifpS
 gh_space_shooter/game/strategies/column_strategy.py,sha256=AQHXVTRe5BEjc4QHRL9QLtkkelTzGUGf2531POGtkG0,1728
 gh_space_shooter/game/strategies/random_strategy.py,sha256=l0GKMkGJa_QEvNrN57R_KgWDBafGebP926fZJqpdghc,2215
 gh_space_shooter/game/strategies/row_strategy.py,sha256=8izcioSGrVYGdQ__GrdfAQxnJt1BLhwNdumeuQiDhpg,1426
-gh_space_shooter-0.0.4.dist-info/METADATA,sha256=DcUrmwjeM1VUOkm1th-R164K3FUYrxYIaj4wwuD8r-0,4310
-gh_space_shooter-0.0.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-gh_space_shooter-0.0.4.dist-info/entry_points.txt,sha256=SmK2ET5vz62eaMC4mhxmLJ1f_H9qSTXOvFOHNo-qwCk,62
-gh_space_shooter-0.0.4.dist-info/licenses/LICENSE,sha256=teCrgzzcmjYCQ-RqXkDmICcHMN1AfaabrjZsW6O3KEk,1075
-gh_space_shooter-0.0.4.dist-info/RECORD,,
+gh_space_shooter-1.0.0.dist-info/METADATA,sha256=6OKZ5hO1uLH3hkzz0aK9l0Fc-6b4ffDSlZYoqIzije4,4462
+gh_space_shooter-1.0.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+gh_space_shooter-1.0.0.dist-info/entry_points.txt,sha256=SmK2ET5vz62eaMC4mhxmLJ1f_H9qSTXOvFOHNo-qwCk,62
+gh_space_shooter-1.0.0.dist-info/licenses/LICENSE,sha256=teCrgzzcmjYCQ-RqXkDmICcHMN1AfaabrjZsW6O3KEk,1075
+gh_space_shooter-1.0.0.dist-info/RECORD,,