gs-reminder

Notify Slack of a review of Pull Requests in the GitHub repository.


License
MIT
Install
pip install gs-reminder==0.5.1

Documentation

gs-reminder

Codacy Badge Code style: black

PyPI Package version Python Supported versions format implementation LICENSE

Notify Slack of a review of Pull Requests in the GitHub repository.

Environments

  • Python 3.8 or later
    • poetry

Usage

pip install gs-reminder
gs-reminder -r nnsnodnb/gs-reminder -u examples/username.json --icon

Environment variables

Options

  • --repo or -r

    • Required
    • Your GitHub repository name. (ex. nnsnodnb/gs-reminder)
  • --file-username or -u

    • Optional
    • Corresponding files for GitHub and Slack usernames. (ex. examples/username.json)
      [
        {
          "github": "nnsnodnb",
          "slack": "yuya.oka"    
        }
      ]
  • --limit or -l

    • Optional
    • Number of Pull Requests to notify Slack. Max: 20 (default: 20)
  • --icon or -i

    • Optional
    • Give GitHub icons to Slack notifications.
  • --exclude-users or -eu

    • Optional
    • GitHub users to remove from reviewers upon notification.
      -eu nnsnodnb # this name is GitHub username
      

Example Result

example result

License

This software is licensed under the MIT License.