Skip to main content

Command line tool to send GitHub pull-request

Project description

Build Status https://badge.fury.io/py/git-pull-request.svg

git-pull-request is a command line tool to send GitHub pull-request from your terminal.

Installation

Use the standard Python installation method:

pip3 install git-pull-request

Usage

You need to write your GitHub credentials into your ~/.netrc file. In case you have 2FA enabled, make sure to replace your password by a Personal access token:

machine github.com login jd password f00b4r

Note: since credentials are stored in plain text, you should encrypt your $HOME directory to improve security.

Once you’ve made your commits into a branch, just type:

git pull-request

This will:

  1. Fork the upstream repository into your account (if needed)

  2. Add your forked repository as a remote named “github” (if needed)

  3. Force push your current branch to your remote

  4. Create a pull-request for your current branch to the remote matching branch, or master by default.

If you add more commits to your branch later, or need to rebase your branch to edit commits, you’ll just need to run git pull-request to update your pull-request. git-pull-request automatically detects that a pull-request has been opened for your current working branch.

Workflow advice

When sending pull-requests, it’s preferable to do so from your own branch. You can create your own branch from master by doing:

$ git checkout -b myownbranch --track origin/master

This will checkout a new branch called myownbranch that is a copy of master. Using the –track option makes sure that the upstream source branch is written in your .git/config file. This will allow git-pull-request to know to which branch send the pull-request.

Since this is long to type, you can use an alias in git to make it faster:

$ git config --global alias.nb '!git checkout --track $(git config branch.$(git rev-parse --abbrev-ref HEAD).remote)/$(git rev-parse --abbrev-ref HEAD) -b'

This will create a git nb alias that will create a new branch tracking the current branch and checking it out. You can then use it like that:

$ git nb foobar
Branch foobar set up to track remote branch master from origin.
Switched to a new branch 'foobar'

Difference with hub

The wrapper hub provides hub fork and hub pull-request as command line tools to fork and create pull-requests.

Unfortunately, it’s hard to combine these tools in an automated implementation for a complete workflow. For example: If you need to update your pull-request, there’s no way to identify existing pull requests, so calling hub pull-request would just open a new pull-request.

git-pull-request wraps all of these operations into one convenient tool.

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

git-pull-request-2.8.1.tar.gz (19.4 kB view details)

Uploaded Source

Built Distribution

git_pull_request-2.8.1-py2.py3-none-any.whl (15.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file git-pull-request-2.8.1.tar.gz.

File metadata

  • Download URL: git-pull-request-2.8.1.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3

File hashes

Hashes for git-pull-request-2.8.1.tar.gz
Algorithm Hash digest
SHA256 3c6794e6c83e57cba6c2efb8e6c3daf3257a49f5584e21bf0ed5c5f0c1eb740b
MD5 d3ad4ef7964ca4c3d45b81d03801d673
BLAKE2b-256 6df525a741d49748db53e7d94eb07e8bd0b60fab67114179ea9a9a542cb08760

See more details on using hashes here.

File details

Details for the file git_pull_request-2.8.1-py2.py3-none-any.whl.

File metadata

  • Download URL: git_pull_request-2.8.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3

File hashes

Hashes for git_pull_request-2.8.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1ed5ca8cb84a288a1e18c1e1b7e68fddadd8c91a26f78d810eae524879ec95a9
MD5 d3171169776c13f5db2153e555657c2a
BLAKE2b-256 3393360c9cd7e717002f228b7a2b2db70e1a9083c661efbb84775f033021f32e

See more details on using hashes here.

Supported by

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