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 (Required)

Set your OpenAI API key as an environment variable:

# Linux/macOS
export OPENAI_API_KEY=your-api-key-here

# Windows (PowerShell)
$env:OPENAI_API_KEY="your-api-key-here"

🛠 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 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.7.tar.gz (11.5 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.7-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ghpush-0.1.7.tar.gz
  • Upload date:
  • Size: 11.5 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.7.tar.gz
Algorithm Hash digest
SHA256 c15b1d2d97200fb55537cdeb465a13f47614ea9e02a53235a91840f79abcd962
MD5 dea2ade3c8db27e8f21440a96a480d7b
BLAKE2b-256 8a24123a14b957608e11e6da0f40a3efe9f97defaeff0ae1dc9d2c069a173ebd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ghpush-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 11.5 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 2a0e1e8ca89429c826adc4e25a735eff3c0c1f407adacccc8824f46cebee46be
MD5 4ca8b8f17ab6b177c943d90a808314ac
BLAKE2b-256 8ce904530a3bfa10eada6935050333409de2d8a05638f239df4a794243bade88

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