repogif 0.0.2__tar.gz

repogif-0.0.2/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: repogif
+Version: 0.0.2
+Summary: Generate beautiful animated GIFs that mimic GitHub repo stars/forks with realistic visuals. Perfect for social sharing, repo previews, documentation, or just for fun.
+Home-page: https://github.com/jhd3197/repogif
+Author: Juan Denis
+Author-email: juan@vene.co
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+Requires-Dist: Pillow
+Requires-Dist: imageio
+Requires-Dist: imageio-ffmpeg
+Requires-Dist: numpy
+Requires-Dist: playwright
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: summary
+
+# RepoGif 🎥⭐
+
+Generate beautiful animated GIFs that mimic GitHub repo stars/forks with realistic visuals.  
+Perfect for social sharing, repo previews, documentation, or just for fun.
+
+## Features
+
+- 🌈 Gradient backgrounds with authentic GitHub styling
+- 🎨 Web-based animation with HTML/CSS/JS for high-quality visuals
+- ⚙️ Customizable repository name, star count, and fork count
+- 🔍 High-fidelity captures using Puppeteer
+<br><br>
+
+> [!TIP]
+> Starring this repo helps more developers discover RepoGif 🎥
+>
+> ![template1_1k](https://github.com/user-attachments/assets/bf87874c-e22a-45d3-a5d8-6c30d4de478a)
+> 
+<br>
+
+## Install
+
+```bash
+git clone https://github.com/yourname/RepoGif.git
+cd RepoGif
+pip install -e .
+playwright install
+```
+
+### Dependencies
+
+- Pillow - Image processing
+- imageio - GIF creation
+- imageio-ffmpeg - Video encoding support
+- numpy - Numerical operations
+- playwright - Browser automation
+
+## Usage
+
+### Call from Python:
+```python
+from repogif.generator import generate_repo_gif
+
+generate_repo_gif(repo_name="RepoGif", stars=250, forks=30, out="output.gif")
+```
+
+### Run from CLI (after install):
+```bash
+repogif
+```
+
+### Advanced Options
+
+You can customize various aspects of the generated GIF:
+
+```python
+generate_repo_gif(
+    repo_name="MyAwesomeProject",
+    stars="5.8k",  # Supports string format for larger numbers
+    forks=397,
+    out="custom_animation.gif"
+)
+```
+
+## How It Works
+
+RepoGif uses a multi-step process to create high-quality animations:
+
+1. Uses static HTML templates with customizable parameters via URL query strings
+2. Uses Playwright to capture two frames (unstarred and starred states)
+3. Creates final GIF using PIL with 1-second duration per frame
+
+The template-based approach allows for visually appealing animations with:
+- Gradient backgrounds
+- Proper GitHub styling and iconography
+- Realistic cursor positioning
+- Star button interactions with visual feedback
+
+## Customization
+
+The templates are located in `repogif/templates/`, with each template in its own directory:
+- Each template has its own template.html file and necessary assets
+- Templates can be customized via URL parameters:
+  - Repository name
+  - Star count
+  - Fork count
+  - Display dimensions
+- You can also create new templates following the existing structure
+
+---
+
+👉 This repo is fully usable right now. Just run:
+
+```bash
+python examples/example.py
+```
+
+and you'll get a RepoGif output in the examples/ folder 🎥.
+
+## Templates
+
+RepoGif offers a variety of templates to showcase your repository in different styles and formats. Choose the one that best suits your needs.
+
+### Template 1 - Simple Star Animation
+
+A simple 2-frame GIF showing star button animation with authentic GitHub styling.
+
+![template1_1k](https://github.com/user-attachments/assets/8481b384-8f3f-432e-bc64-33fccde73c6f)
+
+
+**Default Dimensions**: Variable based on content
+
+**Variants**:
+- ![template1_no_forks](https://github.com/user-attachments/assets/ec88df4b-9e02-4d60-a9dd-dc7320bf62ec)
+- ![template1_100stars](https://github.com/user-attachments/assets/dc08e923-31ef-4020-8d85-a550737cac9a)
+
+### Template 2 - Square Badge
+
+A square badge displaying repository statistics with clean, modern design.
+
+![square_badge_test](https://github.com/user-attachments/assets/f4956ab0-ee3a-47f1-a3b8-8aa15555ee10)
+
+**Default Dimensions**: 250x250 pixels
+
+### Template 3 - Horizontal Banner
+
+A wide banner perfect for repository headers or documentation pages.
+
+![horizontal_banner_test](https://github.com/user-attachments/assets/4c2c7d0d-8826-40d5-82be-fa83bfbafc9c)
+
+**Default Dimensions**: 600x120 pixels
+
+### Template 4 - Circular Badge
+
+A circular badge with focused repository statistics in a compact form.
+
+![circular_badge_test](https://github.com/user-attachments/assets/6910f76f-30ad-4545-957d-4473b688f61a)
+
+**Default Dimensions**: 250x250 pixels
+
+### Template 5 - Vertical Card
+
+A vertical card layout with gradient background for an elegant presentation.
+
+![vertical_card_test](https://github.com/user-attachments/assets/f6830676-8950-4499-ba00-a5e6589ac47b)
+
+**Default Dimensions**: 300x400 pixels
+
+### Template 6 - Minimalist Tile
+
+A clean, monochrome design focusing on essential repository information.
+
+![minimalist_tile_test](https://github.com/user-attachments/assets/0ed364f5-68c1-4b2d-a2ba-bbc6d6fdec1c)
+
+**Default Dimensions**: 320x200 pixels
+
+### Template 7 - Animated Badge
+
+An eye-catching badge with pulsing star effect animation.
+
+![animated_badge_test](https://github.com/user-attachments/assets/faaecbe6-09a3-40f5-9dfa-092a71c9c846)
+
+**Default Dimensions**: 280x280 pixels
+
+### Template 8 - Commit Pattern
+
+![template8_default](https://github.com/user-attachments/assets/43284e90-93f2-402b-b835-1b94fc037a17)
+
+**Variants**:
+- ![template8_increasing](https://github.com/user-attachments/assets/9d2ff7d7-f2a4-4384-b520-7358810cdd25)
+- ![template8_with_zeros](https://github.com/user-attachments/assets/e1666ee3-8ae6-4fce-a04d-e6cc9be12480)
+
+### Template 9 - Contributors
+
+![template9_clustered](https://github.com/user-attachments/assets/adb8bff4-8719-4e04-8e6e-0b9b03e60f13)
+
+**Variants**:
+- ![template9_large](https://github.com/user-attachments/assets/2f34be6d-be2a-494d-822b-edab90c3af82)
+- ![template9_small](https://github.com/user-attachments/assets/2fab08a1-b792-4088-b49c-85093b5f03f2)
+
+
+## Troubleshooting
+
+### Common Issues
+
+
+#### Blank or Corrupted GIF
+This could be due to:
+- Frame capture issues - Check for browser compatibility
+- Puppeteer configuration - Try running with different arguments
+- File path problems - Ensure all paths are correct
+
+## Example Output
+When run, this package generates an animated GIF showing a GitHub repository with stars and forks, along with a realistic cursor animation.

repogif-0.0.2/README.md

@@ -0,0 +1,194 @@
+# RepoGif 🎥⭐
+
+Generate beautiful animated GIFs that mimic GitHub repo stars/forks with realistic visuals.  
+Perfect for social sharing, repo previews, documentation, or just for fun.
+
+## Features
+
+- 🌈 Gradient backgrounds with authentic GitHub styling
+- 🎨 Web-based animation with HTML/CSS/JS for high-quality visuals
+- ⚙️ Customizable repository name, star count, and fork count
+- 🔍 High-fidelity captures using Puppeteer
+<br><br>
+
+> [!TIP]
+> Starring this repo helps more developers discover RepoGif 🎥
+>
+> ![template1_1k](https://github.com/user-attachments/assets/bf87874c-e22a-45d3-a5d8-6c30d4de478a)
+> 
+<br>
+
+## Install
+
+```bash
+git clone https://github.com/yourname/RepoGif.git
+cd RepoGif
+pip install -e .
+playwright install
+```
+
+### Dependencies
+
+- Pillow - Image processing
+- imageio - GIF creation
+- imageio-ffmpeg - Video encoding support
+- numpy - Numerical operations
+- playwright - Browser automation
+
+## Usage
+
+### Call from Python:
+```python
+from repogif.generator import generate_repo_gif
+
+generate_repo_gif(repo_name="RepoGif", stars=250, forks=30, out="output.gif")
+```
+
+### Run from CLI (after install):
+```bash
+repogif
+```
+
+### Advanced Options
+
+You can customize various aspects of the generated GIF:
+
+```python
+generate_repo_gif(
+    repo_name="MyAwesomeProject",
+    stars="5.8k",  # Supports string format for larger numbers
+    forks=397,
+    out="custom_animation.gif"
+)
+```
+
+## How It Works
+
+RepoGif uses a multi-step process to create high-quality animations:
+
+1. Uses static HTML templates with customizable parameters via URL query strings
+2. Uses Playwright to capture two frames (unstarred and starred states)
+3. Creates final GIF using PIL with 1-second duration per frame
+
+The template-based approach allows for visually appealing animations with:
+- Gradient backgrounds
+- Proper GitHub styling and iconography
+- Realistic cursor positioning
+- Star button interactions with visual feedback
+
+## Customization
+
+The templates are located in `repogif/templates/`, with each template in its own directory:
+- Each template has its own template.html file and necessary assets
+- Templates can be customized via URL parameters:
+  - Repository name
+  - Star count
+  - Fork count
+  - Display dimensions
+- You can also create new templates following the existing structure
+
+---
+
+👉 This repo is fully usable right now. Just run:
+
+```bash
+python examples/example.py
+```
+
+and you'll get a RepoGif output in the examples/ folder 🎥.
+
+## Templates
+
+RepoGif offers a variety of templates to showcase your repository in different styles and formats. Choose the one that best suits your needs.
+
+### Template 1 - Simple Star Animation
+
+A simple 2-frame GIF showing star button animation with authentic GitHub styling.
+
+![template1_1k](https://github.com/user-attachments/assets/8481b384-8f3f-432e-bc64-33fccde73c6f)
+
+
+**Default Dimensions**: Variable based on content
+
+**Variants**:
+- ![template1_no_forks](https://github.com/user-attachments/assets/ec88df4b-9e02-4d60-a9dd-dc7320bf62ec)
+- ![template1_100stars](https://github.com/user-attachments/assets/dc08e923-31ef-4020-8d85-a550737cac9a)
+
+### Template 2 - Square Badge
+
+A square badge displaying repository statistics with clean, modern design.
+
+![square_badge_test](https://github.com/user-attachments/assets/f4956ab0-ee3a-47f1-a3b8-8aa15555ee10)
+
+**Default Dimensions**: 250x250 pixels
+
+### Template 3 - Horizontal Banner
+
+A wide banner perfect for repository headers or documentation pages.
+
+![horizontal_banner_test](https://github.com/user-attachments/assets/4c2c7d0d-8826-40d5-82be-fa83bfbafc9c)
+
+**Default Dimensions**: 600x120 pixels
+
+### Template 4 - Circular Badge
+
+A circular badge with focused repository statistics in a compact form.
+
+![circular_badge_test](https://github.com/user-attachments/assets/6910f76f-30ad-4545-957d-4473b688f61a)
+
+**Default Dimensions**: 250x250 pixels
+
+### Template 5 - Vertical Card
+
+A vertical card layout with gradient background for an elegant presentation.
+
+![vertical_card_test](https://github.com/user-attachments/assets/f6830676-8950-4499-ba00-a5e6589ac47b)
+
+**Default Dimensions**: 300x400 pixels
+
+### Template 6 - Minimalist Tile
+
+A clean, monochrome design focusing on essential repository information.
+
+![minimalist_tile_test](https://github.com/user-attachments/assets/0ed364f5-68c1-4b2d-a2ba-bbc6d6fdec1c)
+
+**Default Dimensions**: 320x200 pixels
+
+### Template 7 - Animated Badge
+
+An eye-catching badge with pulsing star effect animation.
+
+![animated_badge_test](https://github.com/user-attachments/assets/faaecbe6-09a3-40f5-9dfa-092a71c9c846)
+
+**Default Dimensions**: 280x280 pixels
+
+### Template 8 - Commit Pattern
+
+![template8_default](https://github.com/user-attachments/assets/43284e90-93f2-402b-b835-1b94fc037a17)
+
+**Variants**:
+- ![template8_increasing](https://github.com/user-attachments/assets/9d2ff7d7-f2a4-4384-b520-7358810cdd25)
+- ![template8_with_zeros](https://github.com/user-attachments/assets/e1666ee3-8ae6-4fce-a04d-e6cc9be12480)
+
+### Template 9 - Contributors
+
+![template9_clustered](https://github.com/user-attachments/assets/adb8bff4-8719-4e04-8e6e-0b9b03e60f13)
+
+**Variants**:
+- ![template9_large](https://github.com/user-attachments/assets/2f34be6d-be2a-494d-822b-edab90c3af82)
+- ![template9_small](https://github.com/user-attachments/assets/2fab08a1-b792-4088-b49c-85093b5f03f2)
+
+
+## Troubleshooting
+
+### Common Issues
+
+
+#### Blank or Corrupted GIF
+This could be due to:
+- Frame capture issues - Check for browser compatibility
+- Puppeteer configuration - Try running with different arguments
+- File path problems - Ensure all paths are correct
+
+## Example Output
+When run, this package generates an animated GIF showing a GitHub repository with stars and forks, along with a realistic cursor animation.

repogif-0.0.2/repogif/__init__.py

@@ -0,0 +1,3 @@
+from .generator import generate_repo_gif
+
+__all__ = ['generate_repo_gif']

repogif-0.0.2/repogif/generator.py

@@ -0,0 +1,256 @@
+"""
+RepoGif - Generator for GitHub repository header GIFs.
+
+This module provides the main functionality for generating GitHub repository
+header GIFs using customizable templates.
+"""
+
+import os
+import tempfile
+import shutil
+import importlib
+from pathlib import Path
+from PIL import Image
+
+
+class RepoGifGenerator:
+    """
+    Template-based GitHub repository header GIF generator.
+    This class provides a framework for generating repository header GIFs
+    using various templates.
+    """
+    
+    def __init__(self):
+        """Initialize the generator with available templates."""
+        self.templates = {
+            "template1": "repogif.templates.template1",
+            "template2": "repogif.templates.template2",
+            "template3": "repogif.templates.template3",
+            "template4": "repogif.templates.template4",
+            "template5": "repogif.templates.template5",
+            "template6": "repogif.templates.template6",
+            "template7": "repogif.templates.template7",
+            "template8": "repogif.templates.template8",
+            "template9": "repogif.templates.template9"
+        }
+        self.default_template = "template1"
+    
+    def get_available_templates(self):
+        """Returns a list of available template names."""
+        return list(self.templates.keys())
+    
+    def generate_gif(self,
+                     repo_name="repogif",
+                     stars=123,
+                     forks=45,
+                     out="repo.gif",
+                     debug_dir=None,
+                     show_forks=True,
+                     template=None,
+                     width=580,
+                     height=140,
+                     contributors=None,
+                     commits=None):
+        """
+        Generate a GitHub repository header GIF using the specified template.
+        
+        Args:
+            repo_name (str): Name of the repository
+            stars (int/str): Number of stars to display
+            forks (int/str): Number of forks to display
+            out (str): Output path for the GIF
+            debug_dir (str/bool, optional): Directory to save frame images for debugging purposes.
+                                         If None or False, frames are not saved.
+                                         If True, frames are saved to a default directory in the package.
+                                         If a string path, frames are saved to that directory.
+            show_forks (bool, optional): Whether to display the fork section in the repository header.
+            template (str, optional): The template to use for generating the GIF.
+                                    If None, the default template will be used.
+            width (int, optional): Width of the GIF in pixels. Default is 580.
+            height (int, optional): Height of the GIF in pixels. Default is 140.
+            contributors (str, optional): JSON-encoded string of contributors data for template9.
+                                       Each contributor should have 'date', 'login', and 'avatar_url'.
+            commits (str, optional): Comma-separated string of weekly commit counts for template8.
+                                  Example: "10,25,15,30,20,35,40"
+            
+        Returns:
+            None: The GIF is saved to the specified path
+            
+        Raises:
+            ValueError: If the specified template is not available
+            RuntimeError: If required dependencies are not available
+        """
+        # Choose template (use default if not specified)
+        template_name = template or self.default_template
+        
+        if template_name not in self.templates:
+            available = ", ".join(self.get_available_templates())
+            raise ValueError(f"Template '{template_name}' not found. Available templates: {available}")
+        
+        # Import the template
+        try:
+            from playwright.sync_api import sync_playwright
+        except ImportError:
+            raise RuntimeError(
+                "Required dependencies not found. Please install with:\n"
+                "pip install playwright pillow\n"
+                "Then run: playwright install"
+            )
+        
+        # Get the template path
+        template_module = self.templates[template_name]
+        template_dir = os.path.join(os.path.dirname(__file__), 
+                                   "templates", 
+                                   template_name)
+        template_path = os.path.join(template_dir, "template.html")
+        template_url = f"file://{os.path.abspath(template_path)}"
+        
+        # Create temporary directory for frames
+        with tempfile.TemporaryDirectory() as temp_dir:
+            try:
+                # File paths for the two states
+                unstarred_path = os.path.join(temp_dir, "unstarred.png")
+                starred_path = os.path.join(temp_dir, "starred.png")
+                
+                print("Capturing screenshots with Playwright...")
+                with sync_playwright() as p:
+                    browser = p.chromium.launch()
+                    # Set viewport to the specified dimensions
+                    page = browser.new_page(viewport={"width": width, "height": height})
+                    
+                    # Capture unstarred state
+                    print("Capturing unstarred state...")
+                    params = {
+                        "repo_name": repo_name,
+                        "stars": stars,
+                        "forks": forks,
+                        "starred": "false",
+                        "show_forks": "true" if show_forks else "false",
+                        "width": width,
+                        "height": height
+                    }
+                    
+                    # Add commits data for template8
+                    if commits and template_name == "template8":
+                        params["commits"] = commits
+                    
+                    # Add contributors data for template9
+                    if contributors and template_name == "template9":
+                        params["contributors"] = contributors
+                        params["animation_state"] = "initial"
+                    query_string = "&".join([f"{k}={v}" for k, v in params.items()])
+                    page.goto(f"{template_url}?{query_string}")
+                    page.screenshot(path=unstarred_path)
+                    
+                    # Capture starred state
+                    print("Capturing starred state...")
+                    params["starred"] = "true"
+                    
+                    # Update animation state for template9
+                    if contributors and template_name == "template9":
+                        params["animation_state"] = "animated"
+                        
+                    query_string = "&".join([f"{k}={v}" for k, v in params.items()])
+                    page.goto(f"{template_url}?{query_string}")
+                    page.screenshot(path=starred_path)
+                    
+                    browser.close()
+                
+                # Create GIF from the two frames using PIL
+                print("Creating GIF from screenshots...")
+                frames = [Image.open(unstarred_path), Image.open(starred_path)]
+                frames[0].save(
+                    out,
+                    format='GIF',
+                    append_images=[frames[1]],
+                    save_all=True,
+                    duration=1000,  # 1 second per frame
+                    loop=0  # Loop forever
+                )
+                print(f"✅ Saved {out}")
+                
+                # Handle debug frames if debug_dir is provided
+                if debug_dir is not None and debug_dir is not False:
+                    # If debug_dir is True, use the default debug directory in the package
+                    if debug_dir is True:
+                        debug_dir = os.path.join(os.path.dirname(__file__), "debug_frames")
+                        print(f"Debug mode: using default debug directory: {debug_dir}")
+                    else:
+                        print(f"Debug mode: copying frames to {debug_dir}")
+                    
+                    try:
+                        # Create debug directory if it doesn't exist
+                        if not os.path.exists(debug_dir):
+                            os.makedirs(debug_dir)
+                            print(f"Created debug directory: {debug_dir}")
+                        
+                        # Copy frames to the debug directory
+                        frame_files = [unstarred_path, starred_path]
+                        frame_names = ["unstarred.png", "starred.png"]
+                        
+                        for i, frame_file in enumerate(frame_files):
+                            dest_path = os.path.join(debug_dir, frame_names[i])
+                            shutil.copy2(frame_file, dest_path)
+                        
+                        print(f"✅ Copied frames to {debug_dir}")
+                    except PermissionError:
+                        print(f"⚠️ Warning: Permission denied when copying frames to {debug_dir}")
+                    except OSError as e:
+                        print(f"⚠️ Warning: Failed to copy frames to debug directory: {e}")
+                
+            except Exception as e:
+                raise RuntimeError(f"Error generating GIF: {e}")
+
+
+# Create a singleton instance of the generator
+_generator = RepoGifGenerator()
+
+
+# Public API functions
+def generate_repo_gif(repo_name="repogif", stars=123, forks=45, out="repo.gif",
+                     debug_dir=None, show_forks=True, template=None,
+                     width=580, height=140, contributors=None, commits=None):
+    """
+    Generate a GitHub repository header GIF using the specified template.
+    
+    Args:
+        repo_name (str): Name of the repository
+        stars (int/str): Number of stars to display
+        forks (int/str): Number of forks to display
+        out (str): Output path for the GIF
+        debug_dir (str/bool, optional): Directory to save frame images for debugging purposes.
+        show_forks (bool, optional): Whether to display the fork section in the repository header.
+        template (str, optional): The template to use for generating the GIF.
+                                If None, the default template will be used.
+        width (int, optional): Width of the GIF in pixels. Default is 580.
+        height (int, optional): Height of the GIF in pixels. Default is 140.
+        contributors (str, optional): JSON-encoded string of contributors data for template9.
+                                   Each contributor should have 'date', 'login', and 'avatar_url'.
+        commits (str, optional): Comma-separated string of weekly commit counts for template8.
+                              Example: "10,25,15,30,20,35,40"
+        
+    Returns:
+        None: The GIF is saved to the specified path
+    """
+    return _generator.generate_gif(
+        repo_name=repo_name,
+        stars=stars,
+        forks=forks,
+        out=out,
+        debug_dir=debug_dir,
+        show_forks=show_forks,
+        template=template,
+        width=width,
+        height=height,
+        contributors=contributors,
+        commits=commits
+    )
+
+
+def get_available_templates():
+    """Returns a list of available template names."""
+    return _generator.get_available_templates()
+
+
+# Define the public API
+__all__ = ['generate_repo_gif', 'get_available_templates']

repogif-0.0.2/repogif/templates/__init__.py

@@ -0,0 +1,3 @@
+"""
+Templates package for RepoGif
+"""

repogif-0.0.2/repogif/templates/template1/__init__.py

@@ -0,0 +1,3 @@
+"""
+Template 1 for RepoGif - A simple 2-frame GIF showing star button animation
+"""

repogif-0.0.2/repogif/templates/template2/__init__.py

@@ -0,0 +1,3 @@
+"""
+Template 6 for RepoGif - A Square Badge (250x250) showing repository stats
+"""

repogif-0.0.2/repogif/templates/template8/__init__.py

@@ -0,0 +1,3 @@
+"""
+Template 8 for RepoGif - A GitHub-style repository commits per week visualization
+"""

repogif-0.0.2/repogif/templates/template9/__init__.py

@@ -0,0 +1,74 @@
+"""
+Template 9 for RepoGif - A visualization showing repository contributors growth over time
+
+This template shows a GitHub-style visualization of repository contributors growth
+over time. It includes a line/area chart and avatar visualization.
+"""
+
+import json
+from datetime import datetime
+import urllib.parse
+
+# This template handles contributors data, which should be provided as a JSON-encoded string
+# Each contributor entry should contain:
+# - date: ISO date string of first commit
+# - login: GitHub username
+# - avatar_url: URL to avatar image
+
+def parse_contributors(contributors_json):
+    """
+    Parse the JSON-encoded contributors data and sort by date.
+    
+    Args:
+        contributors_json (str): JSON-encoded string of contributors data
+        
+    Returns:
+        list: Sorted list of contributor dictionaries
+    """
+    if not contributors_json:
+        # Return a default list if no contributors provided
+        return []
+    
+    try:
+        contributors = json.loads(contributors_json)
+        # Sort contributors by date (earliest first)
+        return sorted(contributors, key=lambda x: x.get('date', ''))
+    except json.JSONDecodeError:
+        # Return empty list if JSON is invalid
+        return []
+
+def prepare_template_params(repo_name, contributors_data, width=580, height=140):
+    """
+    Prepare parameters for template URL.
+    
+    Args:
+        repo_name (str): Name of the repository
+        contributors_data (str): JSON-encoded string of contributors data
+        width (int): Width of the GIF in pixels
+        height (int): Height of the GIF in pixels
+        
+    Returns:
+        dict: Dictionary of template parameters
+    """
+    # First animation state (initial)
+    initial_params = {
+        "repo_name": repo_name,
+        "contributors": urllib.parse.quote(contributors_data),
+        "animation_state": "initial",
+        "width": width,
+        "height": height
+    }
+    
+    # Second animation state (animated)
+    animated_params = {
+        "repo_name": repo_name,
+        "contributors": urllib.parse.quote(contributors_data),
+        "animation_state": "animated",
+        "width": width,
+        "height": height
+    }
+    
+    return {
+        "initial": initial_params,
+        "animated": animated_params
+    }

repogif-0.0.2/repogif.egg-info/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: repogif
+Version: 0.0.2
+Summary: Generate beautiful animated GIFs that mimic GitHub repo stars/forks with realistic visuals. Perfect for social sharing, repo previews, documentation, or just for fun.
+Home-page: https://github.com/jhd3197/repogif
+Author: Juan Denis
+Author-email: juan@vene.co
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+Requires-Dist: Pillow
+Requires-Dist: imageio
+Requires-Dist: imageio-ffmpeg
+Requires-Dist: numpy
+Requires-Dist: playwright
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: summary
+
+# RepoGif 🎥⭐
+
+Generate beautiful animated GIFs that mimic GitHub repo stars/forks with realistic visuals.  
+Perfect for social sharing, repo previews, documentation, or just for fun.
+
+## Features
+
+- 🌈 Gradient backgrounds with authentic GitHub styling
+- 🎨 Web-based animation with HTML/CSS/JS for high-quality visuals
+- ⚙️ Customizable repository name, star count, and fork count
+- 🔍 High-fidelity captures using Puppeteer
+<br><br>
+
+> [!TIP]
+> Starring this repo helps more developers discover RepoGif 🎥
+>
+> ![template1_1k](https://github.com/user-attachments/assets/bf87874c-e22a-45d3-a5d8-6c30d4de478a)
+> 
+<br>
+
+## Install
+
+```bash
+git clone https://github.com/yourname/RepoGif.git
+cd RepoGif
+pip install -e .
+playwright install
+```
+
+### Dependencies
+
+- Pillow - Image processing
+- imageio - GIF creation
+- imageio-ffmpeg - Video encoding support
+- numpy - Numerical operations
+- playwright - Browser automation
+
+## Usage
+
+### Call from Python:
+```python
+from repogif.generator import generate_repo_gif
+
+generate_repo_gif(repo_name="RepoGif", stars=250, forks=30, out="output.gif")
+```
+
+### Run from CLI (after install):
+```bash
+repogif
+```
+
+### Advanced Options
+
+You can customize various aspects of the generated GIF:
+
+```python
+generate_repo_gif(
+    repo_name="MyAwesomeProject",
+    stars="5.8k",  # Supports string format for larger numbers
+    forks=397,
+    out="custom_animation.gif"
+)
+```
+
+## How It Works
+
+RepoGif uses a multi-step process to create high-quality animations:
+
+1. Uses static HTML templates with customizable parameters via URL query strings
+2. Uses Playwright to capture two frames (unstarred and starred states)
+3. Creates final GIF using PIL with 1-second duration per frame
+
+The template-based approach allows for visually appealing animations with:
+- Gradient backgrounds
+- Proper GitHub styling and iconography
+- Realistic cursor positioning
+- Star button interactions with visual feedback
+
+## Customization
+
+The templates are located in `repogif/templates/`, with each template in its own directory:
+- Each template has its own template.html file and necessary assets
+- Templates can be customized via URL parameters:
+  - Repository name
+  - Star count
+  - Fork count
+  - Display dimensions
+- You can also create new templates following the existing structure
+
+---
+
+👉 This repo is fully usable right now. Just run:
+
+```bash
+python examples/example.py
+```
+
+and you'll get a RepoGif output in the examples/ folder 🎥.
+
+## Templates
+
+RepoGif offers a variety of templates to showcase your repository in different styles and formats. Choose the one that best suits your needs.
+
+### Template 1 - Simple Star Animation
+
+A simple 2-frame GIF showing star button animation with authentic GitHub styling.
+
+![template1_1k](https://github.com/user-attachments/assets/8481b384-8f3f-432e-bc64-33fccde73c6f)
+
+
+**Default Dimensions**: Variable based on content
+
+**Variants**:
+- ![template1_no_forks](https://github.com/user-attachments/assets/ec88df4b-9e02-4d60-a9dd-dc7320bf62ec)
+- ![template1_100stars](https://github.com/user-attachments/assets/dc08e923-31ef-4020-8d85-a550737cac9a)
+
+### Template 2 - Square Badge
+
+A square badge displaying repository statistics with clean, modern design.
+
+![square_badge_test](https://github.com/user-attachments/assets/f4956ab0-ee3a-47f1-a3b8-8aa15555ee10)
+
+**Default Dimensions**: 250x250 pixels
+
+### Template 3 - Horizontal Banner
+
+A wide banner perfect for repository headers or documentation pages.
+
+![horizontal_banner_test](https://github.com/user-attachments/assets/4c2c7d0d-8826-40d5-82be-fa83bfbafc9c)
+
+**Default Dimensions**: 600x120 pixels
+
+### Template 4 - Circular Badge
+
+A circular badge with focused repository statistics in a compact form.
+
+![circular_badge_test](https://github.com/user-attachments/assets/6910f76f-30ad-4545-957d-4473b688f61a)
+
+**Default Dimensions**: 250x250 pixels
+
+### Template 5 - Vertical Card
+
+A vertical card layout with gradient background for an elegant presentation.
+
+![vertical_card_test](https://github.com/user-attachments/assets/f6830676-8950-4499-ba00-a5e6589ac47b)
+
+**Default Dimensions**: 300x400 pixels
+
+### Template 6 - Minimalist Tile
+
+A clean, monochrome design focusing on essential repository information.
+
+![minimalist_tile_test](https://github.com/user-attachments/assets/0ed364f5-68c1-4b2d-a2ba-bbc6d6fdec1c)
+
+**Default Dimensions**: 320x200 pixels
+
+### Template 7 - Animated Badge
+
+An eye-catching badge with pulsing star effect animation.
+
+![animated_badge_test](https://github.com/user-attachments/assets/faaecbe6-09a3-40f5-9dfa-092a71c9c846)
+
+**Default Dimensions**: 280x280 pixels
+
+### Template 8 - Commit Pattern
+
+![template8_default](https://github.com/user-attachments/assets/43284e90-93f2-402b-b835-1b94fc037a17)
+
+**Variants**:
+- ![template8_increasing](https://github.com/user-attachments/assets/9d2ff7d7-f2a4-4384-b520-7358810cdd25)
+- ![template8_with_zeros](https://github.com/user-attachments/assets/e1666ee3-8ae6-4fce-a04d-e6cc9be12480)
+
+### Template 9 - Contributors
+
+![template9_clustered](https://github.com/user-attachments/assets/adb8bff4-8719-4e04-8e6e-0b9b03e60f13)
+
+**Variants**:
+- ![template9_large](https://github.com/user-attachments/assets/2f34be6d-be2a-494d-822b-edab90c3af82)
+- ![template9_small](https://github.com/user-attachments/assets/2fab08a1-b792-4088-b49c-85093b5f03f2)
+
+
+## Troubleshooting
+
+### Common Issues
+
+
+#### Blank or Corrupted GIF
+This could be due to:
+- Frame capture issues - Check for browser compatibility
+- Puppeteer configuration - Try running with different arguments
+- File path problems - Ensure all paths are correct
+
+## Example Output
+When run, this package generates an animated GIF showing a GitHub repository with stars and forks, along with a realistic cursor animation.

repogif-0.0.2/repogif.egg-info/SOURCES.txt

@@ -0,0 +1,21 @@
+README.md
+setup.py
+repogif/__init__.py
+repogif/generator.py
+repogif.egg-info/PKG-INFO
+repogif.egg-info/SOURCES.txt
+repogif.egg-info/dependency_links.txt
+repogif.egg-info/entry_points.txt
+repogif.egg-info/requires.txt
+repogif.egg-info/top_level.txt
+repogif/templates/__init__.py
+repogif/templates/template1/__init__.py
+repogif/templates/template2/__init__.py
+repogif/templates/template3/__init__.py
+repogif/templates/template4/__init__.py
+repogif/templates/template5/__init__.py
+repogif/templates/template6/__init__.py
+repogif/templates/template7/__init__.py
+repogif/templates/template8/__init__.py
+repogif/templates/template9/__init__.py
+tests/test_generator.py

repogif-0.0.2/repogif.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

repogif-0.0.2/repogif.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+repogif = repogif.generator:generate_repo_gif

repogif-0.0.2/repogif.egg-info/requires.txt

@@ -0,0 +1,5 @@
+Pillow
+imageio
+imageio-ffmpeg
+numpy
+playwright

repogif-0.0.2/repogif.egg-info/top_level.txt

@@ -0,0 +1 @@
+repogif

repogif-0.0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

repogif-0.0.2/setup.py

@@ -0,0 +1,34 @@
+from setuptools import setup, find_packages
+from pathlib import Path
+
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text(encoding="utf-8")
+
+setup(
+    name="repogif",
+    version='0.0.2',
+    description="Generate beautiful animated GIFs that mimic GitHub repo stars/forks with realistic visuals. Perfect for social sharing, repo previews, documentation, or just for fun.",
+    author="Juan Denis",
+    author_email="juan@vene.co",
+    url="https://github.com/jhd3197/repogif",
+    packages=find_packages(),
+    install_requires=[
+        "Pillow",
+        "imageio",
+        "imageio-ffmpeg",
+        "numpy",
+        "playwright"
+    ],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    entry_points={
+        "console_scripts": [
+            "repogif=repogif.generator:generate_repo_gif",
+        ],
+    },
+)

repogif-0.0.2/tests/test_generator.py

@@ -0,0 +1,7 @@
+from repogif.generator import generate_repo_gif
+import os
+
+def test_generate():
+    out_file = "test.gif"
+    generate_repo_gif(repo_name="testrepo", stars=5, forks=2, out=out_file)
+    assert os.path.exists(out_file)