ghpush 0.1.0

An AI tool to push files to GitHub repositories

🚀 GHPush

AI-Powered GitHub Pull Request Creation Tool

---

🌟 Overview

GHPush is an intelligent command-line tool that revolutionizes your GitHub workflow by automating pull request creation. Using the power of AI, it analyzes your changes, generates meaningful PR titles and descriptions, and streamlines your contribution process - all without requiring a GitHub token!

✨ Features

• 🤖 AI-Powered Summaries: Leverages OpenAI's GPT models to create contextual PR titles and descriptions
• 🔄 Automated Workflow: Push your branch and open GitHub's PR page in one command
• 📊 Smart Diff Analysis: Intelligent analysis of your code changes
• 🔒 No GitHub Token Needed: Works with your local git configuration
• 🌐 Cross-Platform: Seamless experience on Windows, macOS, and Linux
• ⚡ Fallback Mode: Basic summarization when AI is not configured

🚀 Quick Start

Installation Options

📦 Using pip (Recommended)

pip install ghpush

🛠 Using pipx

# Install pipx if needed
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# Install ghpush
pipx install ghpush

🍺 Using Homebrew (macOS/Linux)

brew tap sukeesh/gpush
brew install gpush

💫 Usage

ghpush --base main

That's it! GHPush will:

1. 📝 Analyze your changes
2. 🤖 Generate a PR title and description
3. 🔄 Push your branch
4. 🌐 Open the PR creation page

⚙️ Configuration

OpenAI Integration (Optional)

1. Create your configuration:

cp .env.example .env

2. Add your OpenAI API key:

OPENAI_API_KEY=your_openai_api_key_here

💡 Note: GHPush works perfectly fine without AI integration, falling back to basic summarization.

🛠 Technical Requirements

• Python ≥ 3.8.1
• Dependencies:
  • Click - CLI interface
  • GitPython - Git operations
  • Rich - Beautiful terminal output
  • OpenAI - AI integration
  • python-dotenv - Environment management

🤝 Contributing

We love contributions! Here's how you can help:

1. 🍴 Fork the repository
2. 🌿 Create your feature branch
3. 💻 Make your changes
4. 🔄 Create a pull request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🌟 Show Your Support

If you find GHPush useful, please consider:

• ⭐ Starring the repository
• 🐛 Reporting issues
• 🤝 Contributing to the code
• 📢 Spreading the word

---

Made with ❤️ by Sukeesh