Skip to main content

Get bugged via Discord or Slack to merge your GitHub pull requests or close open issues.

Project description

Pullbug 🐛

Get bugged via Discord or Slack to merge your GitHub pull requests or close open issues.

Build Status Coverage Status PyPi Licence

Showcase

Pullbug can notify you on Discord or Slack of all open pull requests from GitHub. This tool ensures requests never go unnoticed as it can be setup on a schedule to constantly bug you to merge your work. This is perfect for finding old or stale requests and helps you to stay current on new ones. Pass in a few environment variables, setup a Slackbot or Discord webhook and you're all set to be bugged by Pullbug.

NOTE: Pullbug works best if you have link unfurling turned off for GitHub on Discord and Slack.

Install

# Homebrew install
brew tap justintime50/formulas
brew install pullbug

# Pip install
pip3 install pullbug

# Install locally
just install

Usage

Pullbug works best when run on a schedule. Run one-off reports or setup Pullbug to notify you at whatever interval you'd like to be bugged via Discord or Slack about pull requests.

Pullbug is highly customizable allowing you to choose which messaging service and what kinds of pull requests or issues you'd like.

Usage:
  pullbug --github_token 123... --github_owner justintime50 --github_context users

Options:
  -h, --help            show this help message and exit
  -p, --pulls           Bug GitHub for Pull Requests.
  -i, --issues          Bug GitHub for Issues.
  -gt GITHUB_TOKEN, --github_token GITHUB_TOKEN
                        The token to authenticate with GitHub.
  -go GITHUB_OWNER, --github_owner GITHUB_OWNER
                        The GitHub owner to retrieve pull requests or issues for (can be a user or organization).
  -gs {all,open,closed}, --github_state {all,open,closed}
                        The GitHub state to retrieve pull requests or issues for.
  -gc {orgs,users}, --github_context {orgs,users}
                        The GitHub context to retrieve pull requests or issues for.
  -d, --discord         Send Pullbug messages to Discord.
  -du DISCORD_URL, --discord_url DISCORD_URL
                        The Discord webhook URL to send messages to.
  -s, --slack           Send Pullbug messages to Slack.
  -st SLACK_TOKEN, --slack_token SLACK_TOKEN
                        The Slackbot token to authenticate with Slack.
  -sc SLACK_CHANNEL, --slack_channel SLACK_CHANNEL
                        The Slack channel to send messages to.
  -r REPOS, --repos REPOS
                        A comma-separated list of repos to run Pullbug against.
  -dr, --drafts         Include draft pull requests.
  -l LOCATION, --location LOCATION
                        The location of the Pullbug logs and files.
  --base_url BASE_URL   The base URL of your GitHub instance (useful for enterprise users with custom hostnames).
  --log_level {warning,debug,info,notset,error,critical}
                        The log level used for the tool.
  --disable_descriptions
                        Disables descriptions in messages.
  --quiet               Does not output when there is nothing to bug about.
  --version             show program's version number and exit

Development

# Get a comprehensive list of development tools
just --list

# Run the tool locally
venv/bin/python pullbug/cli.py --help

Trusted By

The following companies use Pullbug:

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

pullbug-6.0.1.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

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

pullbug-6.0.1-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file pullbug-6.0.1.tar.gz.

File metadata

  • Download URL: pullbug-6.0.1.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pullbug-6.0.1.tar.gz
Algorithm Hash digest
SHA256 dc52544365040aa15ebad822896eb6f7b298173abb9a31935a47a5db8e1ab588
MD5 bebea01e95a2cc9148a0e6b413fdfae6
BLAKE2b-256 b964ca37b0a391bbb0f03511ff58c8759c3250bc164bc3a344de3eaa78490db1

See more details on using hashes here.

File details

Details for the file pullbug-6.0.1-py3-none-any.whl.

File metadata

  • Download URL: pullbug-6.0.1-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pullbug-6.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 622bd2866e9dc24d1c2c687a03d83dca4cb10f4981ceba95ebe6bf143ce72176
MD5 953043f931a532e085b48e70be1558b7
BLAKE2b-256 8ab00988438c2bd76619b94865fba14230e2dc7a201978f7ce66a63c9fd2bd02

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