Skip to main content

An AI tool to push files to GitHub repositories

Project description

🚀 GHPush

AI-Powered GitHub Pull Request Creation Tool

PyPI version License: MIT Python 3.8+ Downloads


🌟 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

💫 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
  1. 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

🤝 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

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

ghpush-0.1.4.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ghpush-0.1.4-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file ghpush-0.1.4.tar.gz.

File metadata

  • Download URL: ghpush-0.1.4.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for ghpush-0.1.4.tar.gz
Algorithm Hash digest
SHA256 64de2373f335492aa513e83150b502cb00df5ab39f94bbcf0bb362ceff68b46e
MD5 4a7a6439bab178bf00fdd53a4c8c3f4a
BLAKE2b-256 661670138303b4ea48b921977de45612f124feb611bf070a3fa1b6581bd5eba8

See more details on using hashes here.

File details

Details for the file ghpush-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: ghpush-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for ghpush-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e55af5cb1be629d80e1f4105122bc7ac50af5622a37df1873a8546e5968dc732
MD5 3c62f3a6bbb0f58c025cce13d3b6877f
BLAKE2b-256 3a9d083b39f6934de28ee26d3f4d5d63cf39fd7ced7f339dcfca5362f25019f7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page