github-skyline 1.0.2

Package for generating a 3D contribution map on GitHub

GitHub Skyline (Alternative)

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!

---

вњЁ 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

CLI Mode:

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

рџ“– 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:

   

2. Extract the downloaded archive

3. Run the application:

   Windows:

   • Double-click skyline-wizard.exe

   

   macOS/Linux:

   ./skyline-wizard.bin
   

   

🔧 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.stl

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

• рџђ› Bug Reports: Open an issue
• рџ’Ў Feature Requests: Start a discussion
• 📧 Questions: Check existing issues or start a new discussion

рџЋ‰ 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!