gh-space-shooter 0.0.1__tar.gz → 0.0.3__tar.gz

{gh_space_shooter-0.0.1 → gh_space_shooter-0.0.3}/.github/workflows/publish.yml

@@ -30,9 +30,6 @@ jobs:
     - name: Install Python ${{ env.PYTHON_LATEST }}
       run: uv python install ${{ env.PYTHON_LATEST }}
 
-    - name: Build
-      run: uv build
-
     - name: Bump version
       id: bump
       uses: callowayproject/bump-my-version@master
@@ -41,6 +38,9 @@ jobs:
       with:
         args: ${{ inputs.release_type }}
         github-token: ${{ secrets.GH_TOKEN }}
+    
+    - name: Build
+      run: uv build
 
     - name: Publish
       run: uv publish --token ${{ secrets.PYPI_API_TOKEN }}

gh_space_shooter-0.0.3/.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: Run Tests
+
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize, reopened]
+
+env:
+  PYTHON_LATEST: 3.13
+
+jobs:
+  test:
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.13"]
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+
+    - name: Install Python ${{ matrix.python-version }}
+      run: uv python install ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: uv sync --extra dev
+
+    - name: Run tests
+      run: uv run pytest tests/ -v
+
+    - name: Test Summary
+      if: always()
+      run: |
+        echo "## Test Results" >> $GITHUB_STEP_SUMMARY
+        echo "Tests completed for Python ${{ matrix.python-version }}" >> $GITHUB_STEP_SUMMARY

{gh_space_shooter-0.0.1 → gh_space_shooter-0.0.3}/.gitignore

@@ -17,3 +17,6 @@ wheels/
 # Environment variables (secrets)
 .env
 .env.*
+
+# Test output
+my-contributions.json

{gh_space_shooter-0.0.1 → gh_space_shooter-0.0.3}/PKG-INFO

@@ -1,15 +1,17 @@
 Metadata-Version: 2.4
 Name: gh-space-shooter
-Version: 0.0.1
+Version: 0.0.3
 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-Dist: httpx>=0.27.0
-Requires-Dist: pillow>=10.0.0
+Requires-Dist: pillow>=10.1.0
 Requires-Dist: python-dotenv>=1.0.0
 Requires-Dist: rich>=13.0.0
 Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # gh-space-shooter 🚀
@@ -18,19 +20,49 @@ Transform your GitHub contribution graph into an epic space shooter game!
 
 ![Example Game](example.gif)
 
-## Features
+## Usage
+
+### GitHub Action
+
+Automatically update your game GIF daily using GitHub Actions! Add this workflow to your repository at `.github/workflows/update-game.yml`:
+
+```yaml
+name: Update Space Shooter Game
+
+on:
+  schedule:
+    - cron: '0 0 * * *'  # Daily at midnight UTC
+  workflow_dispatch:  # Allow manual trigger
 
-- 🚀 **Galaga-style space shooter** - Classic arcade gameplay with your contribution data
-- 📊 **GitHub integration** - Fetches your last 52 weeks of contributions automatically
-- 🎮 **Smart enemy AI** - Multiple attack strategies (columns, rows, random patterns)
-- 💥 **Particle effects** - Explosions with randomized particles and smooth animations
-- 🎨 **Polished graphics** - Rounded enemies, smooth ship design, starfield background
-- 📈 **Contribution stats** - View your coding activity statistics
-- 💾 **Export options** - Save both the GIF and raw JSON data
+permissions:
+  contents: write
+
+jobs:
+  update-game:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: czl9707/gh-space-shooter@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          output-path: 'game.gif'
+          strategy: 'random'
+```
+
+Then display it in your README:
+```markdown
+![My GitHub Game](game.gif)
+```
 
-## Installation
+**Action Inputs:**
+- `github-token` (required): GitHub token for fetching contributions
+- `username` (optional): Username to generate game for (defaults to repo owner)
+- `output-path` (optional): Where to save the GIF (default: `gh-space-shooter.gif`)
+- `strategy` (optional): Attack pattern - `column`, `row`, or `random` (default: `random`)
+- `commit-message` (optional): Commit message for the update
 
-### From PyPI (Recommended)
+### From PyPI
 
 ```bash
 pip install gh-space-shooter
@@ -131,8 +163,7 @@ When saved to JSON, the data includes:
         }
       ]
     }
-  ],
-  "fetched_at": "2024-12-30T12:00:00"
+  ]
 }
 ```
 

{gh_space_shooter-0.0.1 → gh_space_shooter-0.0.3}/README.md

@@ -4,19 +4,49 @@ Transform your GitHub contribution graph into an epic space shooter game!
 
 ![Example Game](example.gif)
 
-## Features
+## Usage
+
+### GitHub Action
+
+Automatically update your game GIF daily using GitHub Actions! Add this workflow to your repository at `.github/workflows/update-game.yml`:
+
+```yaml
+name: Update Space Shooter Game
+
+on:
+  schedule:
+    - cron: '0 0 * * *'  # Daily at midnight UTC
+  workflow_dispatch:  # Allow manual trigger
 
-- 🚀 **Galaga-style space shooter** - Classic arcade gameplay with your contribution data
-- 📊 **GitHub integration** - Fetches your last 52 weeks of contributions automatically
-- 🎮 **Smart enemy AI** - Multiple attack strategies (columns, rows, random patterns)
-- 💥 **Particle effects** - Explosions with randomized particles and smooth animations
-- 🎨 **Polished graphics** - Rounded enemies, smooth ship design, starfield background
-- 📈 **Contribution stats** - View your coding activity statistics
-- 💾 **Export options** - Save both the GIF and raw JSON data
+permissions:
+  contents: write
+
+jobs:
+  update-game:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: czl9707/gh-space-shooter@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          output-path: 'game.gif'
+          strategy: 'random'
+```
+
+Then display it in your README:
+```markdown
+![My GitHub Game](game.gif)
+```
 
-## Installation
+**Action Inputs:**
+- `github-token` (required): GitHub token for fetching contributions
+- `username` (optional): Username to generate game for (defaults to repo owner)
+- `output-path` (optional): Where to save the GIF (default: `gh-space-shooter.gif`)
+- `strategy` (optional): Attack pattern - `column`, `row`, or `random` (default: `random`)
+- `commit-message` (optional): Commit message for the update
 
-### From PyPI (Recommended)
+### From PyPI
 
 ```bash
 pip install gh-space-shooter
@@ -117,8 +147,7 @@ When saved to JSON, the data includes:
         }
       ]
     }
-  ],
-  "fetched_at": "2024-12-30T12:00:00"
+  ]
 }
 ```
 

gh_space_shooter-0.0.3/action.yml

@@ -0,0 +1,66 @@
+name: 'GitHub Space Shooter'
+description: 'Transform your GitHub contribution graph into an space shooter game GIF'
+author: 'zane'
+
+branding:
+  icon: 'navigation-2'
+  color: 'black'
+
+inputs:
+  github-token:
+    description: 'GitHub token for fetching contribution data (usually secrets.GITHUB_TOKEN)'
+    required: true
+  username:
+    description: 'GitHub username to generate game for (defaults to repository owner)'
+    required: false
+    default: ${{ github.repository_owner }}
+  output-path:
+    description: 'Path where the GIF should be saved'
+    required: false
+    default: 'gh-space-shooter.gif'
+  strategy:
+    description: 'Enemy attack strategy (column, row, or random)'
+    required: false
+    default: 'random'
+  commit-message:
+    description: 'Commit message for the GIF update'
+    required: false
+    default: 'Update space shooter game GIF'
+
+outputs:
+  gif-path:
+    description: 'Path to the generated GIF file'
+    value: ${{ steps.generate.outputs.gif-path }}
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+
+    - name: Install gh-space-shooter
+      shell: bash
+      run: |
+        python -m pip install --upgrade pip
+        pip install gh-space-shooter
+
+    - name: Generate game GIF
+      id: generate
+      shell: bash
+      env:
+        GH_TOKEN: ${{ inputs.github-token }}
+      run: |
+        gh-space-shooter ${{ inputs.username }} \
+          --output ${{ inputs.output-path }} \
+          --strategy ${{ inputs.strategy }}
+
+    - name: Commit and push GIF
+      shell: bash
+      run: |
+        git config --local user.email "github-actions[bot]@users.noreply.github.com"
+        git config --local user.name "github-actions[bot]"
+        git add ${{ inputs.output-path }}
+        git diff --staged --quiet || git commit -m "${{ inputs.commit-message }}"
+        git push

{gh_space_shooter-0.0.1 → gh_space_shooter-0.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gh-space-shooter"
-version = "0.0.1"
+version = "0.0.3"
 description = "A CLI tool that visualizes GitHub contribution graphs as gamified GIFs"
 readme = "README.md"
 authors = [
@@ -12,7 +12,12 @@ dependencies = [
     "httpx>=0.27.0",
     "python-dotenv>=1.0.0",
     "rich>=13.0.0",
-    "pillow>=10.0.0",
+    "pillow>=10.1.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
 ]
 
 [project.scripts]
@@ -24,7 +29,7 @@ build-backend = "hatchling.build"
 
 
 [tool.bumpversion]
-current_version = "0.0.1"
+current_version = "0.0.3"
 parse = """(?x)
   (?P<major>0|[1-9]\\d*)\\.
   (?P<minor>0|[1-9]\\d*)\\.
@@ -47,4 +52,8 @@ commit_args = ""
 [[tool.bumpversion.files]]
 filename = "pyproject.toml"
 search = "version = \"{current_version}\""
-replace = "version = \"{new_version}\""
+replace = "version = \"{new_version}\""
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

gh_space_shooter-0.0.3/src/gh_space_shooter/constants.py

@@ -0,0 +1,19 @@
+"""Global constants for the application."""
+
+# GitHub contribution graph dimensions
+NUM_WEEKS = 52  # Number of weeks in contribution graph
+NUM_DAYS = 7  # Number of days in a week (Sun-Sat)
+SHIP_POSITION_Y = NUM_DAYS + 3  # Ship is positioned just below the grid
+
+SHIP_SPEED = 0.25  # Cells per frame the ship moves
+BULLET_SPEED = 0.15  # Cells per frame the bullet moves
+BULLET_TRAILING_LENGTH = 3  # Number of trailing segments for bullets
+FRAME_DURATION_MS = 20  # Duration of each frame in milliseconds
+SHIP_SHOOT_COOLDOWN_FRAMES = 10  # Frames between ship shots
+
+EXPLOSION_PARTICLE_COUNT_LARGE = 8  # Number of particles in a large explosion
+EXPLOSION_PARTICLE_COUNT_SMALL = 4  # Number of particles in a small explosion
+EXPLOSION_MAX_RADIUS_LARGE = 20  # Max radius for large explosions
+EXPLOSION_MAX_RADIUS_SMALL = 10  # Max radius for small explosions
+EXPLOSION_MAX_FRAMES_LARGE = 20  # Frames for large explosion animation
+EXPLOSION_MAX_FRAMES_SMALL = 6  # Frames for small explosion animation

{gh_space_shooter-0.0.1 → gh_space_shooter-0.0.3}/src/gh_space_shooter/game/drawables/bullet.py

@@ -4,7 +4,7 @@ from typing import TYPE_CHECKING
 
 from PIL import ImageDraw
 
-from ...constants import BULLET_SPEED, SHIP_POSITION_Y
+from ...constants import BULLET_SPEED, BULLET_TRAILING_LENGTH, SHIP_POSITION_Y
 from .drawable import Drawable
 from .explosion import Explosion
 
@@ -52,10 +52,9 @@ class Bullet(Drawable):
     def draw(self, draw: ImageDraw.ImageDraw, context: "RenderContext") -> None:
         """Draw the bullet with trailing tail effect."""
 
-        trail_num = 3
-        for i in range(trail_num):
+        for i in range(BULLET_TRAILING_LENGTH):
             trail_y = self.y + (i + 1) * BULLET_SPEED
-            fade_factor = (i + 1) / trail_num / 2
+            fade_factor = (i + 1) / BULLET_TRAILING_LENGTH / 2
             self._draw_bullet(draw, context, (self.x, trail_y), fade_factor=fade_factor)
 
         self._draw_bullet(draw, context, (self.x, self.y), fade_factor=0.3, offset=.6)

{gh_space_shooter-0.0.1 → gh_space_shooter-0.0.3}/src/gh_space_shooter/game/drawables/explosion.py

@@ -6,6 +6,14 @@ from typing import TYPE_CHECKING, Literal
 
 from PIL import ImageDraw
 
+from ...constants import (
+    EXPLOSION_MAX_FRAMES_LARGE,
+    EXPLOSION_MAX_FRAMES_SMALL,
+    EXPLOSION_MAX_RADIUS_LARGE,
+    EXPLOSION_MAX_RADIUS_SMALL,
+    EXPLOSION_PARTICLE_COUNT_LARGE,
+    EXPLOSION_PARTICLE_COUNT_SMALL,
+)
 from .drawable import Drawable
 
 if TYPE_CHECKING:
@@ -30,10 +38,9 @@ class Explosion(Drawable):
         self.y = y
         self.game_state = game_state
         self.frame = 0
-        self.max_frames = 6 if size == "small" else 20
-        self.max_radius = 10 if size == "small" else 20
-        self.particle_count = 4 if size == "small" else 8
-        # Generate random angles for each particle
+        self.max_frames = EXPLOSION_MAX_FRAMES_SMALL if size == "small" else EXPLOSION_MAX_FRAMES_LARGE
+        self.max_radius = EXPLOSION_MAX_RADIUS_SMALL if size == "small" else EXPLOSION_MAX_RADIUS_LARGE
+        self.particle_count = EXPLOSION_PARTICLE_COUNT_SMALL if size == "small" else EXPLOSION_PARTICLE_COUNT_LARGE
         self.particle_angles = [random.uniform(0, 2 * math.pi) for _ in range(self.particle_count)]
 
     def animate(self) -> None:
@@ -44,21 +51,18 @@ class Explosion(Drawable):
 
     def draw(self, draw: ImageDraw.ImageDraw, context: "RenderContext") -> None:
         """Draw expanding particle explosion with fade effect."""
-        # Calculate animation progress (0 to 1)
+
         progress = self.frame / self.max_frames
         fade = 1 - progress  # Fade out as animation progresses
 
-        # Get center position
         center_x, center_y = context.get_cell_position(self.x, self.y)
         center_x += context.cell_size // 2
         center_y += context.cell_size // 2
 
-        # Draw expanding particles in random directions
         for i in range(self.particle_count):
             distance = progress * self.max_radius
             angle = self.particle_angles[i]
 
-            # Particle position using random angle
             px = int(center_x + distance * math.cos(angle))
             py = int(center_y + distance * math.sin(angle))
 

{gh_space_shooter-0.0.1 → gh_space_shooter-0.0.3}/src/gh_space_shooter/github_client.py

@@ -32,7 +32,6 @@ class ContributionData(TypedDict):
     username: str
     total_contributions: int
     weeks: list[ContributionWeek]
-    fetched_at: str
 
 
 class GitHubAPIError(Exception):
@@ -157,7 +156,6 @@ class GitHubClient:
             "username": username,
             "total_contributions": calendar["totalContributions"],
             "weeks": weeks,
-            "fetched_at": datetime.now().isoformat(),
         }
 
     LEVEL_MAP = {

gh_space_shooter-0.0.3/tests/conftest.py

@@ -0,0 +1,27 @@
+"""Shared test fixtures for gh-space-shooter tests."""
+
+import pytest
+from gh_space_shooter.game.game_state import GameState
+from gh_space_shooter.github_client import ContributionData
+
+
+@pytest.fixture
+def empty_contribution_data() -> ContributionData:
+    """Create contribution data with no contributions."""
+    return {
+        "weeks": [
+            {
+                "days": [
+                    {"level": 0, "date": "", "count": 0} for _ in range(7)
+                ]
+            }
+            for _ in range(52)
+        ],
+        "total_contributions": 0,
+        "username": "test_user",
+    }
+
+@pytest.fixture
+def default_game_state(empty_contribution_data):
+    """Create a game state with no enemies."""
+    return GameState(empty_contribution_data)

gh_space_shooter-0.0.3/tests/test_bullet_collision.py

@@ -0,0 +1,121 @@
+"""Tests for bullet collision detection logic."""
+
+from gh_space_shooter.game.game_state import GameState
+from gh_space_shooter.game.drawables import Bullet, Enemy
+from gh_space_shooter.constants import EXPLOSION_MAX_FRAMES_SMALL, EXPLOSION_MAX_FRAMES_LARGE
+
+
+class TestBulletCollision:
+    """Tests for bullet collision detection and behavior."""
+
+    def test_collision_detection_same_x_position(self, default_game_state: GameState) -> None:
+        """Test that bullet detects collision when at same x position as enemy."""
+
+        enemy = Enemy(x=5, y=3, health=2, game_state=default_game_state)
+        default_game_state.enemies.append(enemy)
+        bullet = Bullet(x=5, game_state=default_game_state)
+        bullet.y = 2.0
+        default_game_state.bullets.append(bullet)
+
+        hit_enemy = bullet._check_collision()
+        assert hit_enemy is enemy
+
+        bullet.animate()
+        assert bullet not in default_game_state.bullets
+
+    def test_collision_detection_enemy_above_bullet(self, default_game_state: GameState) -> None:
+        """Test that collision is detected when enemy.y >= bullet.y."""
+
+        enemy = Enemy(x=5, y=3, health=2, game_state=default_game_state)
+        default_game_state.enemies.append(enemy)
+        bullet = Bullet(x=5, game_state=default_game_state)
+        bullet.y = 2.5
+        default_game_state.bullets.append(bullet)
+
+        hit_enemy = bullet._check_collision()
+        assert hit_enemy is enemy
+
+        bullet.animate()
+        assert bullet not in default_game_state.bullets
+
+    def test_no_collision_different_x_position(self, default_game_state: GameState) -> None:
+        """Test that bullet doesn't detect collision at different x positions."""
+
+        enemy = Enemy(x=5, y=3, health=2, game_state=default_game_state)
+        default_game_state.enemies.append(enemy)
+
+        bullet = Bullet(x=6, game_state=default_game_state)
+        bullet.y = 3.0
+
+        hit_enemy = bullet._check_collision()
+        assert hit_enemy is None
+
+    def test_bullet_damages_enemy_on_collision(self, default_game_state: GameState) -> None:
+        """Test that bullet damages enemy on collision."""
+
+        enemy = Enemy(x=5, y=3, health=3, game_state=default_game_state)
+        default_game_state.enemies.append(enemy)
+
+        bullet = Bullet(x=5, game_state=default_game_state)
+        bullet.y = 2.0
+        default_game_state.bullets.append(bullet)
+
+        bullet.animate()
+        assert enemy.health == 2
+
+    def test_enemy_destroyed_when_health_zero(self, default_game_state: GameState) -> None:
+        """Test that enemy is removed when health reaches zero."""
+
+        enemy = Enemy(x=5, y=3, health=1, game_state=default_game_state)
+        default_game_state.enemies.append(enemy)
+
+        bullet = Bullet(x=5, game_state=default_game_state)
+        bullet.y = 2.0
+        default_game_state.bullets.append(bullet)
+
+        bullet.animate()
+        assert enemy not in default_game_state.enemies
+
+    def test_explosion_created_on_collision(self, default_game_state: GameState) -> None:
+        """Test that explosion is created when bullet hits enemy."""
+
+        enemy = Enemy(x=5, y=3, health=2, game_state=default_game_state)
+        default_game_state.enemies.append(enemy)
+
+        bullet = Bullet(x=5, game_state=default_game_state)
+        bullet.y = 2.0
+        default_game_state.bullets.append(bullet)
+
+        bullet.animate()
+        assert len(default_game_state.explosions) == 1
+        assert default_game_state.explosions[0].max_frames == EXPLOSION_MAX_FRAMES_SMALL
+
+    def test_large_explosion_on_enemy_destroyed(self, default_game_state: GameState) -> None:
+        """Test that large explosion is created when enemy is destroyed."""
+
+        enemy = Enemy(x=5, y=3, health=1, game_state=default_game_state)
+        default_game_state.enemies.append(enemy)
+
+        bullet = Bullet(x=5, game_state=default_game_state)
+        bullet.y = 2.0
+        default_game_state.bullets.append(bullet)
+
+        bullet.animate()
+        # Should have 2 explosions: small from bullet hit, large from enemy destruction
+        assert len(default_game_state.explosions) == 2
+        explosion_max_frames = [exp.max_frames for exp in default_game_state.explosions]
+        assert EXPLOSION_MAX_FRAMES_SMALL in explosion_max_frames
+        assert EXPLOSION_MAX_FRAMES_LARGE in explosion_max_frames
+
+    def test_bullet_removed_when_off_screen(self, default_game_state: GameState) -> None:
+        """Test that bullet is removed when it goes off screen (y < -10)."""
+
+        bullet = Bullet(x=5, game_state=default_game_state)
+        bullet.y = -5.0
+        default_game_state.bullets.append(bullet)
+
+        for _ in range(50):
+            if bullet in default_game_state.bullets:
+                bullet.animate()
+
+        assert bullet not in default_game_state.bullets