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!
- 🎯 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
pip install github-skylineTUI Mode:
python -m github_skyline
CLI Mode:
python -m github_skyline --help
python -m github_skyline -u your-username -y 2024-
Install the package:
pip install github-skyline
-
Launch TUI:
python -m github_skyline
-
Or use CLI:
python -m github_skyline -u your-username -y 2024
| 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 |
# 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.stlOfficial 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.
This project is licensed under the MIT License - see the LICENSE file for details.
- 🐛 Bug Reports: Open an issue
- 💡 Feature Requests: Start a discussion
- 📧 Questions: Check existing issues or start a new discussion
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!