| Name | gs-reminder JSON |
| Version |
0.5.3
JSON |
| download |
| home_page | https://github.com/nnsnodnb/gs-reminder |
| Summary | Notify Slack of a review of Pull Requests in the GitHub repository. |
| upload_time | 2024-12-25 10:03:50 |
| maintainer | None |
| docs_url | None |
| author | Yuya Oka |
| requires_python | <3.14,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# gs-reminder
[](https://www.codacy.com/gh/nnsnodnb/gs-reminder/dashboard?utm_source=github.com&utm_medium=referral&utm_content=nnsnodnb/gs-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.9 or later
- poetry
## Usage
```shell
pip install gs-reminder
gs-reminder -r nnsnodnb/gs-reminder -u examples/username.json --icon
```
### 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/gs-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)
- `--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
<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/gs-reminder",
"name": "gs-reminder",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Yuya Oka",
"author_email": "nnsnodnb@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/60/a1/d9336cf6dcc99d81fb728b9cee27745d0fd07689b5f349addf5b5a5d5fad/gs_reminder-0.5.3.tar.gz",
"platform": null,
"description": "# gs-reminder\n\n[](https://www.codacy.com/gh/nnsnodnb/gs-reminder/dashboard?utm_source=github.com&utm_medium=referral&utm_content=nnsnodnb/gs-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.9 or later\n - poetry\n\n## Usage\n\n```shell\npip install gs-reminder\ngs-reminder -r nnsnodnb/gs-reminder -u examples/username.json --icon\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/gs-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- `--icon` or `-i`\n - Optional\n - Give GitHub icons to Slack notifications.\n\n- `--exclude-users` or `-eu`\n - Optional\n - GitHub users to remove from reviewers upon notification.\n ```\n -eu nnsnodnb # this name is GitHub username\n ```\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.5.3",
"project_urls": {
"Homepage": "https://github.com/nnsnodnb/gs-reminder",
"Repository": "https://github.com/nnsnodnb/gs-reminder"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3c9babdf58c76b5e01d5dc550a6e87fdfd9a6b90daed409b915e0ee6256a0608",
"md5": "3a17b52d7b8550c9379a97b537f89419",
"sha256": "ec30d6107cec8caacac72d6a2d69b7c3f6822aa3c274ed822f4c6b36e681f224"
},
"downloads": -1,
"filename": "gs_reminder-0.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a17b52d7b8550c9379a97b537f89419",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.9",
"size": 9374,
"upload_time": "2024-12-25T10:03:48",
"upload_time_iso_8601": "2024-12-25T10:03:48.490108Z",
"url": "https://files.pythonhosted.org/packages/3c/9b/abdf58c76b5e01d5dc550a6e87fdfd9a6b90daed409b915e0ee6256a0608/gs_reminder-0.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "60a1d9336cf6dcc99d81fb728b9cee27745d0fd07689b5f349addf5b5a5d5fad",
"md5": "b9493f6be23ad0cef5602d155c170e46",
"sha256": "564efa76d6f5c2858bd96bce9a3a818fe0abc5cb079f9029c290ebd11c2e3ff7"
},
"downloads": -1,
"filename": "gs_reminder-0.5.3.tar.gz",
"has_sig": false,
"md5_digest": "b9493f6be23ad0cef5602d155c170e46",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.9",
"size": 7082,
"upload_time": "2024-12-25T10:03:50",
"upload_time_iso_8601": "2024-12-25T10:03:50.740490Z",
"url": "https://files.pythonhosted.org/packages/60/a1/d9336cf6dcc99d81fb728b9cee27745d0fd07689b5f349addf5b5a5d5fad/gs_reminder-0.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-25 10:03:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nnsnodnb",
"github_project": "gs-reminder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gs-reminder"
}
