https://github.com/doctorixx/github-skyline
This program generate 3d graph of your contributions to GitHub platform
https://github.com/doctorixx/github-skyline
export-stl generator github github-skyline
Last synced: 9 days ago
JSON representation
This program generate 3d graph of your contributions to GitHub platform
- Host: GitHub
- URL: https://github.com/doctorixx/github-skyline
- Owner: doctorixx
- Created: 2024-08-01T07:43:02.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-12-31T10:01:05.000Z (25 days ago)
- Last Synced: 2026-01-04T14:25:11.916Z (21 days ago)
- Topics: export-stl, generator, github, github-skyline
- Language: Python
- Homepage:
- Size: 3.29 MB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Skyline (Alternative)
[](https://www.python.org/downloads/)
[](LICENSE)
**An alternative implementation of [GitHub Skyline](https://skyline.github.com/) 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
```bash
pip install github-skyline
```
### Generate Your Skyline
**TUI Mode:**
```bash
python -m github_skyline
```
**CLI Mode:**
```bash
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:**
```bash
pip install github-skyline
```
2. **Launch TUI:**
```bash
python -m github_skyline
```
3. **Or use CLI:**
```bash
python -m github_skyline -u your-username -y 2024
```
## 🔧 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
```bash
# 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](https://github.com/github/gh-skyline), 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](LICENSE) file for details.
## 🤝 Support
- 🐛 **Bug Reports:** [Open an issue](https://github.com/doctorixx/github-skyline/issues)
- 💡 **Feature Requests:** [Start a discussion](https://github.com/doctorixx/github-skyline/discussions)
- 📧 **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!**