gh-space-shooter 0.0.1__py3-none-any.whl

gh_space_shooter/github_client.py

@@ -0,0 +1,172 @@
+"""GitHub API client for fetching contribution graph data."""
+
+from datetime import datetime
+from typing import TypedDict
+
+import httpx
+from dotenv import load_dotenv
+
+from .constants import NUM_WEEKS
+
+# Load environment variables from .env file
+load_dotenv()
+
+
+class ContributionDay(TypedDict):
+    """Represents a single day's contribution data."""
+
+    date: str
+    count: int
+    level: int  # 0-4 intensity level
+
+
+class ContributionWeek(TypedDict):
+    """Represents a week of contribution data."""
+
+    days: list[ContributionDay]
+
+
+class ContributionData(TypedDict):
+    """Complete contribution graph data."""
+
+    username: str
+    total_contributions: int
+    weeks: list[ContributionWeek]
+    fetched_at: str
+
+
+class GitHubAPIError(Exception):
+    """Raised when GitHub API request fails."""
+
+    pass
+
+
+class GitHubClient:
+    """Client for interacting with GitHub's GraphQL API."""
+
+    GITHUB_API_URL = "https://api.github.com/graphql"
+    GET_CONTRIBUTION_GRAPH_QUERY = """
+        query($username: String!) {
+            user(login: $username) {
+            contributionsCollection {
+                contributionCalendar {
+                totalContributions
+                weeks {
+                    contributionDays {
+                    date
+                    contributionCount
+                    contributionLevel
+                    }
+                }
+                }
+            }
+            }
+        }
+    """
+
+    def __init__(self, token: str):
+        """
+        Initialize GitHub client.
+
+        Args:
+            token: GitHub personal access token (required).
+        """
+        self.token = token
+        self.client = httpx.Client(
+            headers={
+                "Authorization": f"Bearer {self.token}",
+                "Content-Type": "application/json",
+            },
+            timeout=30.0,
+        )
+
+    def __enter__(self):
+        """Context manager entry."""
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """Context manager exit - close HTTP client."""
+        self.close()
+
+    def close(self):
+        self.client.close()
+
+    def get_contribution_graph(self, username: str) -> ContributionData:
+        """
+        Fetch contribution graph for a GitHub user (last 52 weeks).
+
+        Args:
+            username: GitHub username to fetch data for
+
+        Returns:
+            ContributionData with user's contribution information
+
+        Raises:
+            GitHubAPIError: If the API request fails
+        """
+
+        try:
+            response = self.client.post(
+                self.GITHUB_API_URL,
+                json={
+                    "query": self.GET_CONTRIBUTION_GRAPH_QUERY, 
+                    "variables": {"username": username}
+                },
+            )
+            response.raise_for_status()
+        except httpx.HTTPError as e:
+            raise GitHubAPIError(f"Failed to fetch data from GitHub API: {e}") from e
+
+        data = response.json()
+
+        # Check for GraphQL errors
+        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)}")
+
+        # Check if user exists
+        if not data.get("data", {}).get("user"):
+            raise GitHubAPIError(f"User '{username}' not found")
+
+        # Extract contribution data
+        calendar = data["data"]["user"]["contributionsCollection"][
+            "contributionCalendar"
+        ]
+
+        # Parse weeks and days
+        weeks: list[ContributionWeek] = []
+        for week_data in calendar["weeks"]:
+            days: list[ContributionDay] = []
+            for day_data in week_data["contributionDays"]:
+                days.append(
+                    {
+                        "date": day_data["date"],
+                        "count": day_data["contributionCount"],
+                        "level": self._contribution_level_to_int(
+                            day_data["contributionLevel"]
+                        ),
+                    }
+                )
+            weeks.append({"days": days})
+
+        # Always return exactly NUM_WEEKS (truncate if more)
+        weeks = weeks[-NUM_WEEKS:] if len(weeks) > NUM_WEEKS else weeks
+
+        return {
+            "username": username,
+            "total_contributions": calendar["totalContributions"],
+            "weeks": weeks,
+            "fetched_at": datetime.now().isoformat(),
+        }
+
+    LEVEL_MAP = {
+        "NONE": 0,
+        "FIRST_QUARTILE": 1,
+        "SECOND_QUARTILE": 2,
+        "THIRD_QUARTILE": 3,
+        "FOURTH_QUARTILE": 4,
+    }
+
+    def _contribution_level_to_int(self, level: str) -> int:
+        return self.LEVEL_MAP.get(level, 0)

gh_space_shooter-0.0.1.dist-info/METADATA

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: gh-space-shooter
+Version: 0.0.1
+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: python-dotenv>=1.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.12.0
+Description-Content-Type: text/markdown
+
+# gh-space-shooter 🚀
+
+Transform your GitHub contribution graph into an epic space shooter game! 
+
+![Example Game](example.gif)
+
+## Features
+
+- 🚀 **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
+
+## Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install gh-space-shooter
+```
+
+### From Source
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/gh-space-shooter.git
+cd gh-space-shooter
+
+# Install with uv
+uv sync
+
+# Or with pip
+pip install -e .
+```
+
+## Setup
+
+1. Create a GitHub Personal Access Token:
+   - Go to https://github.com/settings/tokens
+   - Click "Generate new token (classic)"
+   - Select scopes: `read:user`
+   - Copy the generated token
+
+2. Set up your environment:
+   ```bash
+   # Copy the example env file
+   touch .env
+   echo "GH_TOKEN=your_token_here" >> .env
+   ```
+
+   Alternatively, export the token directly:
+   ```bash
+   export GH_TOKEN=your_token_here
+   ```
+
+## Usage
+
+### Generate Your Game GIF
+
+Transform your GitHub contributions into an epic space shooter!
+
+```bash
+# Basic usage - generates username-gh-space-shooter.gif
+gh-space-shooter <username>
+
+# Examples
+gh-space-shooter torvalds
+gh-space-shooter octocat
+
+# Specify custom output filename
+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)
+```
+
+This creates an animated GIF showing:
+- Your contribution graph as enemies (more contributions = stronger enemies)
+- A Galaga-style spaceship battling through your coding history
+- Enemy attack patterns based on your chosen strategy
+- Smooth animations with randomized particle effects
+- Your contribution stats displayed in the console
+
+### Advanced Options
+
+```bash
+# Save raw contribution data to JSON
+gh-space-shooter torvalds --raw-output data.json
+
+# Load from previously saved JSON (saves API rate limits)
+gh-space-shooter --raw-input data.json --output game.gif
+
+# Combine options
+gh-space-shooter torvalds -o game.gif -ro data.json -s column
+```
+
+### Data Format
+
+When saved to JSON, the data includes:
+```json
+{
+  "username": "torvalds",
+  "total_contributions": 1234,
+  "weeks": [
+    {
+      "days": [
+        {
+          "date": "2024-01-01",
+          "count": 5,
+          "level": 2
+        }
+      ]
+    }
+  ],
+  "fetched_at": "2024-12-30T12:00:00"
+}
+```
+
+## License
+
+MIT

gh_space_shooter-0.0.1.dist-info/RECORD

@@ -0,0 +1,28 @@
+gh_space_shooter/__init__.py,sha256=jBFfHY3YC8-3m-eVPIo3CWoQLsy5Yvd0vcbHVbUDTWY,337
+gh_space_shooter/cli.py,sha256=AHONWh6Kv9Y8D7OWsnOH6kOjN73aSCXF8Ats9jKJwkY,5310
+gh_space_shooter/console_printer.py,sha256=opT5vITkPJ_9BCPNMDays6EtXez9m86YXY9pK5_Hdh8,2345
+gh_space_shooter/constants.py,sha256=HR_FYewYnjQ8V5fJwMS2UhiYSS3l0iR5Y8bmaS3thQE,498
+gh_space_shooter/github_client.py,sha256=Ugt4wi8RAvnYPO8fF7-MgugD5t91nxQUcEnCf-Hmc-8,4771
+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=5nCY0xfRl6tifwixUlUlVXCQfDjhsR6HbQBKHHmYHH8,2998
+gh_space_shooter/game/game_state.py,sha256=pvKc-FAapVXuFNb2hCGoOhJI1P8kWXkyCf_lruc-j50,2804
+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/drawables/__init__.py,sha256=lzo3O5cxahrYTyOQVrz7rQ3Prkaj8Z_dpzlt0UdurOo,306
+gh_space_shooter/game/drawables/bullet.py,sha256=8DjqXI1Ab4IINi77szJuRc5Bqilb0gvofKgcQ9s0ONM,2920
+gh_space_shooter/game/drawables/drawable.py,sha256=xIJWI5m-kZCbvCfgYF4jiqTvPFelViJ1gLilz7adJoM,738
+gh_space_shooter/game/drawables/enemy.py,sha256=RCIE4Vn2tis0iJmJO_JUIxnomSgDSsfFhrcPPWmFLhE,1921
+gh_space_shooter/game/drawables/explosion.py,sha256=Ek2CCjjifkLVSpaJ4Nv8ey1VhkXNK6HeKK3wB0fRI5g,2618
+gh_space_shooter/game/drawables/ship.py,sha256=j389lXOUWvPoFZUNvVN-OEjhTtIlEkAVeEYqF7gDBIE,3216
+gh_space_shooter/game/drawables/starfield.py,sha256=ON_cQ6Qfg30ocLHQEp1dceqputHmxJ7sf61o4uNF4Ng,2530
+gh_space_shooter/game/strategies/__init__.py,sha256=a34i4FlNv-aQ-oEkT1ha7oJDBt7Cd7EFpbMWsYNHpW0,338
+gh_space_shooter/game/strategies/base_strategy.py,sha256=IwPdthCWkgsFdUsMjQgifpSJv1bPRCCuUMF0o00y6pk,1152
+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.1.dist-info/METADATA,sha256=YIu9i1FpQeGP4PCJvohXG_cs2_O9bFR9HMHhWTu0J84,3493
+gh_space_shooter-0.0.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+gh_space_shooter-0.0.1.dist-info/entry_points.txt,sha256=SmK2ET5vz62eaMC4mhxmLJ1f_H9qSTXOvFOHNo-qwCk,62
+gh_space_shooter-0.0.1.dist-info/licenses/LICENSE,sha256=teCrgzzcmjYCQ-RqXkDmICcHMN1AfaabrjZsW6O3KEk,1075
+gh_space_shooter-0.0.1.dist-info/RECORD,,

gh_space_shooter-0.0.1.dist-info/WHEEL

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

gh_space_shooter-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gh-space-shooter = gh_space_shooter.cli:app

gh_space_shooter-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Zane Chen
+
+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.