# github-pr-slack-reminder
[](https://www.codacy.com/gh/nnsnodnb/github-pr-slack-reminder/dashboard?utm_source=github.com&utm_medium=referral&utm_content=nnsnodnb/github-pr-slack-reminder&utm_campaign=Badge_Grade)
[](https://github.com/psf/black)
[](https://pypi.org/project/gs-reminder)
[](https://pypi.org/project/gs-reminder)
[](https://pypi.org/project/gs-reminder)
[](https://pypi.org/project/gs-reminder)
[](https://pypi.org/project/gs-reminder)
Notify Slack of a review of Pull Requests in the GitHub repository.
## Environments
- Python 3.7 or later
- poetry
## Usage
```shell
pip install gs-reminder
gs-reminder -r nnsnodnb/github-pr-slack-reminder -u examples/username.json
```
### Environment variables
- `GITHUB_TOKEN`
- Required
- Your GitHub Personal Access Token.
- Create https://github.com/settings/tokens
- `SLACK_URL`
- Required
- Incoming webhook's url of Slack app.
### Options
- `--repo` or `-r`
- Required
- Your GitHub repository name. (ex. `nnsnodnb/github-pr-slack-reminder`)
- `--file-username` or `-u`
- Optional
- Corresponding files for GitHub and Slack usernames. (ex. `examples/username.json`)
```json
[
{
"github": "nnsnodnb",
"slack": "yuya.oka"
}
]
```
- `--limit` or `-l`
- Optional
- Number of Pull Requests to notify Slack. Max: 20 (default: 20)
## Example Result
<img src="https://user-images.githubusercontent.com/9856514/168442310-af165e75-7329-4a37-8e67-3f2635c549ac.png" alt="example result" width="500px">
## License
This software is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": "https://github.com/nnsnodnb/github-pr-slack-reminder",
"name": "gs-reminder",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Yuya Oka",
"author_email": "nnsnodnb@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2d/89/8c0ff33f3def003a9b837d40a226406458e5826410870f6de1815b9261ea/gs-reminder-0.3.1.tar.gz",
"platform": null,
"description": "# github-pr-slack-reminder\n\n[](https://www.codacy.com/gh/nnsnodnb/github-pr-slack-reminder/dashboard?utm_source=github.com&utm_medium=referral&utm_content=nnsnodnb/github-pr-slack-reminder&utm_campaign=Badge_Grade)\n[](https://github.com/psf/black)\n\n[](https://pypi.org/project/gs-reminder)\n[](https://pypi.org/project/gs-reminder)\n[](https://pypi.org/project/gs-reminder)\n[](https://pypi.org/project/gs-reminder)\n[](https://pypi.org/project/gs-reminder)\n\nNotify Slack of a review of Pull Requests in the GitHub repository.\n\n## Environments\n\n- Python 3.7 or later\n - poetry\n\n## Usage\n\n```shell\npip install gs-reminder\ngs-reminder -r nnsnodnb/github-pr-slack-reminder -u examples/username.json\n```\n\n### Environment variables\n\n- `GITHUB_TOKEN`\n - Required\n - Your GitHub Personal Access Token.\n - Create https://github.com/settings/tokens\n- `SLACK_URL`\n - Required\n - Incoming webhook's url of Slack app.\n\n### Options\n\n- `--repo` or `-r`\n - Required\n - Your GitHub repository name. (ex. `nnsnodnb/github-pr-slack-reminder`)\n- `--file-username` or `-u`\n - Optional\n - Corresponding files for GitHub and Slack usernames. (ex. `examples/username.json`)\n ```json\n [\n {\n \"github\": \"nnsnodnb\",\n \"slack\": \"yuya.oka\" \n }\n ]\n ```\n\n- `--limit` or `-l`\n - Optional\n - Number of Pull Requests to notify Slack. Max: 20 (default: 20)\n\n## Example Result\n\n<img src=\"https://user-images.githubusercontent.com/9856514/168442310-af165e75-7329-4a37-8e67-3f2635c549ac.png\" alt=\"example result\" width=\"500px\">\n\n## License\n\nThis software is licensed under the MIT License.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Notify Slack of a review of Pull Requests in the GitHub repository.",
"version": "0.3.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "263635fce235fe75cf47d56e55f784b4",
"sha256": "7917323991f99f85a7341ef61ddfc581525162e10c1217285dc94dbfe3b94808"
},
"downloads": -1,
"filename": "gs_reminder-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "263635fce235fe75cf47d56e55f784b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 8119,
"upload_time": "2022-05-21T10:12:49",
"upload_time_iso_8601": "2022-05-21T10:12:49.636985Z",
"url": "https://files.pythonhosted.org/packages/7a/ab/7df8b86c5399fdaa7cae3c2e22b29e9bffd3980691177c8c0e3435e5ba73/gs_reminder-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "2a07c41bc87de7ac9a301fe9adbd170d",
"sha256": "3233b0230a8555c4771487464a35feca3b4c83aa37827078d111b6581b225fb6"
},
"downloads": -1,
"filename": "gs-reminder-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "2a07c41bc87de7ac9a301fe9adbd170d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 6653,
"upload_time": "2022-05-21T10:12:48",
"upload_time_iso_8601": "2022-05-21T10:12:48.399986Z",
"url": "https://files.pythonhosted.org/packages/2d/89/8c0ff33f3def003a9b837d40a226406458e5826410870f6de1815b9261ea/gs-reminder-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-05-21 10:12:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "nnsnodnb",
"github_project": "github-pr-slack-reminder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gs-reminder"
}
JSON
