Skip to main content

A simple CLI tool to check PR statuses on GitHub

Project description

PR Checker

pr-checker is a CLI tool to check the status of pull requests on GitHub for a specified user or team. It supports initializing configuration, updating specific configuration parts, and checking the status of PRs.

Features

  • Initialize configuration with GitHub username, token, team usernames, and repositories.
  • Update specific parts of the configuration such as GitHub token, username, team usernames, and repositories.
  • Check the status of open and closed pull requests for specified date ranges.

Installation

Install the package using pip:

pip install pr-checker

Usage

Initialize Configuration

The first time you use pr-checker, you need to initialize the configuration:

pr-checker --init

This will prompt you to enter your GitHub username, token, team usernames, and repositories to check.

Update Configuration

You can update specific parts of the configuration as needed.

Update GitHub Token

pr-checker --update --set-token NEW_TOKEN

Update GitHub username

pr-checker --update --set-username NEW_USERNAME

Update Team Usernames

pr-checker --update --set-team "user1,user2"

Update repositories

pr-checker --update --set-repos "Repo1/repo1, Repo2/repo2"

Check Pull Requests

You can check the status of pull requests using various options.

Default

No options checks PRs in all repos for both you and your team for the last 7 days.

pr-checker

Check Open Pull Requests for a Specific Date Range

pr-checker --status open --start-date 2022-01-01 --end-date 2022-01-31 --who me

Get only your pull requests

pr-checker --who team

Arguments

  • --init: Initialize the configuration.
  • --update: Update the configuration.
    • --set-username: Set the GitHub username.
    • --set-token: Set the GitHub token.
    • --set-team: Set the team usernames (comma-separated).
    • --set-repos: Set the repositories to check (comma-separated).
  • --status: Status of the PRs (open or closed). Leave blank for both.
  • --start-date: Start date for the PRs.
  • --end-date: End date for the PRs.
  • --who: Who to check PRs for (me or team). Leave blank for team (includes me)

License

This project is licensed under the MIT License.

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

pr_checker-0.1.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

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

pr_checker-0.1-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file pr_checker-0.1.tar.gz.

File metadata

  • Download URL: pr_checker-0.1.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.10

File hashes

Hashes for pr_checker-0.1.tar.gz
Algorithm Hash digest
SHA256 5a95ee3b03642ea29e4d7d0785fe6e0a4a5e37a353863a4b222f74f68d5efee2
MD5 c7831c16e1acb99f88d5542c10684ec8
BLAKE2b-256 92fdcbd0f819dfcbc8488bfa00c65cb4f57b9d9acbf5477f60f8ddb663578f59

See more details on using hashes here.

File details

Details for the file pr_checker-0.1-py3-none-any.whl.

File metadata

  • Download URL: pr_checker-0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.10

File hashes

Hashes for pr_checker-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 30e88864ed15c36a25f28d251e11ca583ecae545ac04cda8ac448133a3af3737
MD5 ad2e0c872bf197d220ced040568bb785
BLAKE2b-256 59298b9019ee7a017ba0ba29446e052742860c9a0f95ec4a65c0b097069647ef

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