A Stardew Valley X Halloween -inspired terminal companion for your git repository
Project description
GitGotchi - Your Friendly Dev Companion
A Stardew Valley-inspired terminal companion that lives in your git repository!
Features
- Adorable pixel art companion that evolves based on your coding habits
- Warm, encouraging stories about your code history
- Automatic feeding through git hooks
- Friendship system inspired by Stardew Valley
- Cozy terminal UI with beautiful colors
- Fast evolution - see changes every 2-3 commits!
Installation
pip install gitgotchi
Quick Start
# Navigate to any git repository
cd your-project
# Install git hooks for automatic feeding
gitgotchi install
# Meet your companion!
gitgotchi status
Commands
gitgotchi status- See your companion's current stategitgotchi pet- Give them affection (boosts mood)gitgotchi story- Hear an AI-generated story about your codegitgotchi evolve- Check evolution progress and requirementsgitgotchi name <name>- Give your companion a custom namegitgotchi install- Install git hooks for automatic feedinggitgotchi uninstall- Remove git hooks
Evolution Forms
Your companion evolves based on commit count and code quality:
- Egg (0-2 commits) - Starting form
- Ghost (3-5 commits) - Default evolution path
- Angel (6+ commits, quality > 70) - High quality code path
- Demon (6+ commits, quality < 30) - Chaotic but playful path
- Zombie (4+ reverts) - Needs coffee, sleepy form
- Wraith (15+ commits) - Ultimate ethereal form
Code Quality Factors
- Descriptive commit messages (+15 points)
- Reasonable commit size (+5 points)
- Including tests (+10 points)
- Vague messages like "fix" (-20 points)
- Huge commits >500 lines (-15 points)
Configuration
Set your Anthropic API key for story generation (optional):
export ANTHROPIC_API_KEY='your-key-here'
# or create a .env file
echo "ANTHROPIC_API_KEY=your-key-here" > .env
Requirements
- Python 3.10 or higher
- Git installed and configured
- A git repository (run
git initif needed)
License
MIT License - see LICENSE file for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gitgotchi-0.1.3.tar.gz.
File metadata
- Download URL: gitgotchi-0.1.3.tar.gz
- Upload date:
- Size: 23.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aae83a846c6bb5fa02916ac85df25700e3d196e23eecf48b34727a8fd5956ae0
|
|
| MD5 |
e642de0abcfb7cf035f50810f62aaa4d
|
|
| BLAKE2b-256 |
4f60048ba6f8e181e6e161d2201d991addfdf612c4dfe06064996661a832e5dc
|
File details
Details for the file gitgotchi-0.1.3-py3-none-any.whl.
File metadata
- Download URL: gitgotchi-0.1.3-py3-none-any.whl
- Upload date:
- Size: 20.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
804820132983e583ed566351488324d9c0aac4b1f1fc03bec57dfca44eef5c8e
|
|
| MD5 |
73377782e5454fe0b3dbd4c5a78c2b4b
|
|
| BLAKE2b-256 |
7b688f4676f6980e40eceb1e51882decf555ddddc422771c9e316fe7d59bec70
|