Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 937 Bytes

README.md

File metadata and controls

36 lines (26 loc) · 937 Bytes
Raw

pull-requests

⬆️ A command line tool for creating pull requests.

Requirements

  • Python 3.10 or above

Installation

pip install pull-requests

Usage

First of all, you need to have a file in your project root directory called pr.json. That file needs to have the following fields in order to make the program works. See below an example of that file structure:

{
    "username": "YOUR_GITHUB_USERNAME",
    "repository": "YOUR_REPOSITORY_NAME",
    "token": "YOUR_GITHUB_ACCESS_TOKEN"
}

That's is everything we need to use the program. Now, on your project root directory, you can the following command:

pull-requests --from "HEAD_BRANCH" --to "BASE_BRANCH" --title "Some optional title" --body "Some optional body text"

Title is optional. If you don't set the title, HEAD_BRANCH name will be used.

License

This project is licensed under the MIT license. See LICENSE.