Skip to content

This program generate 3d graph of your contributions to GitHub platform

Notifications You must be signed in to change notification settings

doctorixx/github-skyline

Folders and files

NameName
Last commit message
Last commit date

Latest commit

4db8f03Β Β·Β Β· Aug 26, 2025

History

40 Commits
Aug 5, 2024
May 12, 2025
Jul 12, 2025
Jul 30, 2024
May 12, 2025
Aug 26, 2025
Aug 26, 2025

Repository files navigation

GitHub Skyline (Alternative)

Export STL Python License

An alternative implementation of GitHub Skyline that generates 3D models of your GitHub contribution history.

Transform your GitHub contributions into stunning 3D landscapes that you can 3D print, display, or share!

GitHub Skyline Render


✨ Features

  • 🎯 Faithful Design: Follows the original GitHub Skyline design (unlike the official CLI)
  • πŸ–₯️ Multiple Interfaces: GUI, CLI, and Python library support
  • πŸ“¦ Cross-Platform: Works on Windows, macOS, and Linux
  • 🎨 STL Export: Ready-to-print 3D models
  • πŸš€ Easy Installation: Simple pip install or standalone binaries

πŸš€ Quick Start

Installation

pip install github-skyline

Generate Your Skyline

GUI Mode:

python -m github_skyline

img.png

CLI Mode:

python -m github_skyline --help
python -m github_skyline -u your-username -y 20244

πŸ“– Detailed Usage

Method 1: Python Package (Recommended)

  1. Install the package:

    pip install github-skyline
  2. Launch GUI:

    python -m github_skyline
  3. Or use CLI:

    python -m github_skyline -u your-username -y 2024

[DEPRECATED] Method 2: Standalone Binaries

  1. Download: Go to Releases and download the appropriate binary for your system:

    Release Assets

  2. Extract the downloaded archive

  3. Run the application:

    Windows:

    • Double-click skyline-wizard.exe

    Windows Example

    macOS/Linux:

    ./skyline-wizard.bin

    Linux Example

πŸ”§ CLI Options

CLI Options

Available Commands

Option Description Example
-u, --username GitHub username -u doctorixx
-y, --year Year to generate -y 2024
-o, --output Output filename -o my-skyline.stl
-h, --help Show help message --help

Examples

# Generate skyline for user 'doctorixx' for 2024
python -m github_skyline -u doctorixx -y 2024



# Custom output filename
python -m github_skyline -u doctorixx -y 2024 -o my-contributions.stll

Official CLI Differences: While GitHub has released an official CLI tool, it uses a different design. This project maintains compatibility with the original GitHub Skyline website design.

πŸ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

🀝 Support

πŸŽ‰ Showcase

Share your GitHub Skylines! Tag us or open a discussion to show off your 3D printed contributions.


Made with ❀️ by the community | Star ⭐ this repo if you find it useful!

About

This program generate 3d graph of your contributions to GitHub platform

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages