https://github.com/kuberwastaken/github-art
Turn your GitHub Commit History into a Pixel Art Canvas
https://github.com/kuberwastaken/github-art
commits github-art pixel-art python
Last synced: 10 months ago
JSON representation
Turn your GitHub Commit History into a Pixel Art Canvas
- Host: GitHub
- URL: https://github.com/kuberwastaken/github-art
- Owner: Kuberwastaken
- License: apache-2.0
- Created: 2024-11-05T08:51:34.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-05T10:59:08.000Z (about 1 year ago)
- Last Synced: 2025-04-24T02:05:20.398Z (10 months ago)
- Topics: commits, github-art, pixel-art, python
- Language: Python
- Homepage:
- Size: 495 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github-Art
Create Pixel Art in your GitHub Commit History using a simple Python Script.
## Overview
### Why Does this Project Exist
Short answer, because it's a fun idea. In a world where your technological capability as a developer is measured by how green your contribution chart is, adding a custom flair to it just seems like a fun idea.
I saw the contribution chart as a 52 x 7 canvas to show art on, this unlocks unlimited possibilities
### How Does It Work
This project allows you to generate pixel art in your GitHub commit history. By using a customizable matrix, you can create a visual representation directly on your GitHub profile.
## Usage
1. **Fork this Repository**:
Fork this repository to your GitHub account.
2. **Clone the Repository**:
Clone the forked repository to your local machine:
```
bash git clone https://github.com/yourusername/Github-Art.git
```
3. **Create Your Pixel Art**:
Edit the matrix in the script with #s and .s, where . represent commits and # represents no commits. This matrix will fit the commit history display on GitHub.
2. **Run the Script**:
- Install the required Python package (Pillow):
```bash
pip install pillow
```
- Execute the script to generate commits:
```bash
python generate_commits.py
```
3. **Push Your Commits**:
- Once the script has created the commits, push them to your repository:
```bash
git push origin main
```
Your GitHub profile will now display your pixel art in the commit history!
## Requirements
- Python 3.x
- Pillow library
## Disclaimer
This script is intended for educational and experimental purposes only. Misuse of this script to violate GitHub’s Terms of Service, such as artificially inflating commit activity or creating spam, is not recommended or endorsed. Please use this tool responsibly and ethically, respecting GitHub’s guidelines and the integrity of the platform.
## License
This project is licensed under the Apache-2.0 license License. See the [LICENSE](LICENSE) file for details.