GITAID - Git Assistant for Instant Development

🚀 GITAID

Git Assistant for Instant Development

Automate your Python project setup in 30 seconds. One command. Complete dev environment. Ready to code.

./setup-project.sh
# or
python3 setup-project.py

🎯 What is GITAID?

GITAID eliminates the tedious setup steps for Python projects by automating:

✅ Git configuration & SSH keys
✅ Python 3.12 environment via uv
✅ Virtual environment with direnv
✅ Aider AI coding assistant
✅ Django projects (optional)
✅ Professional .gitignore & documentation

From zero to coding in 30 seconds.

🌟 Features

Intelligent Setup

Interactive prompts with validation
Sensible defaults for quick setup
Dry-run mode to preview changes
Color-coded output & detailed logging

Git Excellence

Clone existing repos or create new ones
Auto-configure user name & email
Generate SSH keys (ed25519 or RSA 4096)
Pre-configure GitHub, GitLab, and custom servers
Test connections automatically

Python Environment

Install Python 3.12 via uv
Create isolated virtual environment
Auto-activation with direnv
Install Aider for AI-assisted development
Optional Django project scaffolding

Developer Experience

Comprehensive .gitignore (Python/Django)
Professional README.md template
Modern pyproject.toml configuration
Proper directory permissions
Everything logged for troubleshooting

📦 Quick Start

Installation

# Download GITAID
curl -O https://gitaid.dev/setup-project.sh
chmod +x setup-project.sh

# Or Python version
curl -O https://gitaid.dev/setup-project.py
chmod +x setup-project.py

Basic Usage

# Bash version
./setup-project.sh

# Python version
python3 setup-project.py

# Preview mode (no changes)
./setup-project.sh --dry-run
python3 setup-project.py --dry-run

Example Session

$ ./setup-project.sh

[INFO] GITAID - Git Assistant for Instant Development

Base directory [/opt]: /opt
Project name: awesome-app
Git repository URL: 
Git user name: Jane Developer
Git user email: jane@example.com
Install direnv? [Y/n]: y
Install Aider? [Y/n]: y
Setup SSH key for git? [Y/n]: y

[SUCCESS] ✓ Project created at /opt/awesome-app
[SUCCESS] ✓ SSH key configured for GitHub, GitLab, and Mooncalf
[SUCCESS] ✓ Python 3.12 environment ready
[SUCCESS] ✓ Aider installed

All done! 🎉

🎨 Two Implementations

GITAID comes in two flavors:

Bash Version (`setup-project.sh`)

1,099 lines of shell scripting
No dependencies beyond bash
Perfect for sysadmins
Natural for system operations

Python Version (`setup-project.py`)

1,056 lines of clean Python
Object-oriented design
Easy to extend
Great for Python developers

Both do exactly the same thing!

🔧 What Gets Created

/opt/awesome-app/
├── .git/                 # Git repository
├── .venv/                # Python 3.12 virtual environment
├── .envrc                # direnv auto-activation
├── .gitignore            # Comprehensive Python/Django ignores
├── README.md             # Project documentation
├── pyproject.toml        # Modern Python configuration
└── config/               # Django project (if requested)
    ├── manage.py
    └── config/
        ├── settings.py
        ├── urls.py
        └── wsgi.py

Plus in your home directory:

~/.ssh/
├── id_ed25519           # Private SSH key
├── id_ed25519.pub       # Public SSH key (for git providers)
└── config               # Auto-configured for GitHub, GitLab, etc.

🔑 SSH Key Management

GITAID generates SSH keys and configures them for: - GitHub (github.com) - GitLab (gitlab.com) - Custom GitLab (e.g., mooncalf.rockypy.com)

After key generation, GITAID: 1. Displays your public key 2. Shows direct links to add keys 3. Optionally copies to clipboard 4. Tests connections 5. You’re ready to push code!

No more password prompts. Ever.

🎓 Use Cases

For Beginners

# First Python project
./setup-project.sh
# Follow the prompts
# Start coding in 30 seconds

For Professionals

# New microservice
./setup-project.sh --dry-run  # Check first
./setup-project.sh            # Create it
cd /opt/new-service
aider                         # AI-assisted development

For Teams

# Onboard new developer
# 1. Give them GITAID script
# 2. They run it once
# 3. Consistent dev environment
# 4. Ready to contribute

For Lightning Talks

# Show both versions
./setup-project.sh      # Bash
python3 setup-project.py # Python
# Same result, different approach!

📚 Documentation

USAGE.md - Detailed usage guide
SSH-FEATURES.md - SSH key documentation
TESTING-CHECKLIST.md - QA procedures
LIGHTNING-TALK.md - Bash vs Python comparison

🚦 Prerequisites

Ubuntu/Debian Linux (tested on 24.04)
Bash shell (for .sh version)
Python 3.6+ (for .py version)
sudo access (for package installation)
Internet connection

That’s it! GITAID installs everything else.

🔍 How It Works

Gather Configuration
- Base directory
- Project name
- Git settings
- Optional features
System Setup
- Install direnv & git (if needed)
- Install uv Python manager
- Update PATH in .bashrc
Project Creation
- Create directory (with proper ownership)
- Initialize or clone git repo
- Configure git user
SSH Setup (optional)
- Generate SSH key pair
- Configure for git hosts
- Add to ssh-agent
- Test connections
Python Environment
- Install Python 3.12
- Create virtual environment
- Setup direnv for auto-activation
- Install Aider (optional)
Finishing Touches
- Create .gitignore
- Generate README.md
- Setup Django (optional)
- Display next steps

All in about 30 seconds!

🎯 Why GITAID?

Before GITAID

mkdir project
cd project
git init
git config user.name "..."
git config user.email "..."
ssh-keygen -t ed25519...
cat ~/.ssh/id_ed25519.pub  # Copy to GitHub
python3 -m venv .venv
source .venv/bin/activate
pip install ...
touch .gitignore
# 15 more manual steps...
# 20 minutes later... maybe it works?

With GITAID

./setup-project.sh
# 30 seconds later: ✅ Ready to code!

💡 Design Philosophy

Automate the tedious, validate the important, make it pleasant.

Every input validated
Every step logged
Every error handled gracefully
Every feature tested
Everything documented

🤝 Contributing

GITAID is perfect for your local Python user group or team!

Ideas for Enhancement

Support for Poetry/PDM
Docker integration
Pre-commit hooks
GitHub Actions templates
More framework options (Flask, FastAPI)

# Share with your team
git clone https://github.com/yourrepo/gitaid
cd gitaid
./setup-project.sh  # They're ready!

🎤 Lightning Talk

GITAID was created for a Python user group lightning talk comparing Bash and Python for DevOps automation.

Key Points: - Same functionality, two languages - Bash: 1,099 lines, great for shell operations - Python: 1,056 lines, great for complex logic - Both work perfectly!

See LIGHTNING-TALK.md for the complete talk.

📊 Stats

Metric	Bash	Python
Lines of Code	1,099	1,056
Functions/Methods	30+	25+
File Size	28 KB	35 KB
Startup Time	Instant	~50ms
Execution Time	~30s	~30s
Dependencies	bash, curl, sudo	Python 3.6+, subprocess

Performance: Identical (bottleneck is network/system ops)

🐛 Troubleshooting

Command not found after install

source ~/.bashrc
# or restart your terminal

Permission denied

chmod +x setup-project.sh
# or
chmod +x setup-project.py

SSH key not working

# Add key to GitHub/GitLab first
cat ~/.ssh/id_ed25519.pub  # Copy this

# Test connection
ssh -T git@github.com

Check the logs

# Every run creates a log
tail -f /tmp/project-setup-*.log

🎓 Learn More

Blog Posts

“Building GITAID: Automating Python Project Setup”
“Bash vs Python for DevOps: A Real-World Comparison”
“Zero to Git in 30 Seconds with GITAID”

Videos

Lightning Talk: “GITAID - One Script, Two Languages”
Demo: “Setting Up Python Projects the Easy Way”

📜 License

GITAID is provided as-is for development automation. Feel free to modify and adapt for your needs.

🙏 Acknowledgments

Created for the local Python user group to demonstrate: - DevOps automation - Bash vs Python comparison - Real-world scripting

🔗 Links

Repository: https://github.com/yourrepo/gitaid
Issues: https://github.com/yourrepo/gitaid/issues
Documentation: https://github.com/yourrepo/gitaid/docs
Python Group: [Your local meetup]

🌟 Star Us!

If GITAID saves you time, give it a star! ⭐

# One script
./setup-project.sh

# Complete environment
# Ready to code
# That's GITAID! 🚀

GITAID - Because life’s too short for manual project setup.

Git Assistant for Instant Development-- Created by RoofSoft - Mike George