# Reviewcheck
Reviewcheck is a tool to stay up to date with your reviews on GitLab. You can
configure it to use any GitLab instance you have access to. The tool checks all
open merge requests in the repositories chosen by you, and lets you know if
there are open threads that need your attention.
Reviewcheck is in active development.
## Installation
Reviewcheck depends on Python >=3.8.1. There are multiple ways to install it.
The simplest is with `pipx`.
### With `pipx`
Reviewcheck can be installed with the following command:
```console
$ pipx install reviewcheck
```
### With Poetry
If you are a developer, the best way to test changes you make without having to
create a Python package and install it is to clone the repository and run
`poetry run reviewcheck` from within it. You will need to have poetry
installed. The process looks as follows:
```console
$ pipx install poetry
$ git clone https://github.com/volvo-cars/Reviewcheck
$ cd reviewcheck
$ poetry install
$ poetry run reviewcheck
```
### With Docker
There's also a Dockerfile available to use. Currently it does not get uploaded
anywhere, so you'll need to build it locally and then run it. Example commands:
```console
$ docker build -t reviewcheck .
$ docker run -tv ~/.config/reviewcheckrc:/root/.config/reviewcheckrc reviewcheck
```
## Getting Started
Reviewcheck has a terminal-based user interface. You run it on the command line
with `reviewcheck`. The first time you run it, you will be able to
interactively configure it to find your reviews.
After that, any time you run `reviewcheck`, you will be presented with a list
of threads from any MR where your response is needed. You can configure how
verbose the output is with options. See the `--help` option for more information
about that.
Whenever there is a new review comment that wasn't present the last time
Reviewcheck fetched comments, you will receive a desktop notification. An
example:
Notifications are sent using `notify-send` so the notification should look like
any other desktop notification on your system. They will likely differ in
visual appearance from the example image.
### Configuration
The first time you run Reviewcheck, the interactive configuration will start. If
you ever want to reconfigure it, just run `reviewcheck configure`. You can also
modify the configuration file directly. Unless you configured a separate
configurations directory, it should be in `~/.config/reviewcheckrc`.
You will be asked for an access token. It can be created in your GitLab
settings, under "User settings" > "Access Token". It should have at least the
`read_api` access.
You will also be asked for your "GitLab URL". For the main GitLab instance, it
would be `https://gitlab.com` but if you have your own instance, use that
instead. Do not add a slash at the end.
There is the possibility to add a Jira base URL. It is used if you have Jira
ticket referenced in your commits. An example would be
`https://jira.example.com`.
Finally, you should fill in the project IDs of projects where you want to track
merge requests. This can be a bit tricky to find and you might need to consult
the GitLab documentation. It may be under the title of your repository. It may
also be to the right of the title, under the three-dots menu.
After that, you're all set.
## FAQ
<dl>
<dt>How do I configure Reviewcheck?</dt>
<dd>The first time you run `reviewcheck`, the interactive configuration will
start. You can rerun it with `reviewcheck configure`. If you know what you're
doing, you may also edit the configuration file directly. You'll find the
configuration file `reviewcheckrc` in your configuration files directory,
usually `~/.config/`.</dd>
<dt>Will you support other software hosting pages than GitLab?</dt>
<dd>Yes! We hope to support Gerrit in the near future and Gitea and GitHub in the
far future.</dd>
<dt>What triggers the desktop notifications?</dt>
<dd>When Reviewcheck is run and a new message is discovered in a thread that
Reviewcheck judges you should respond to, you will get a desktop notification
containing the new message. This may be useful when you're running in a loop
with the `--refresh` option.</dd>
<dt>Why are you asking for a JIRA URL?</dt>
<dd>This is only relevant if your organization uses JIRA and tags merge requests
with the JIRA ticket number. It will help Reviewcheck provide you with a link
to the ticket connected to the merge request. Please report a bug if your
organization uses JIRA but the current system doesn't work for you.</dd>
<dt>How can I get regular updates without having to remember to run Reviewcheck?</dt>
<dd>You may benefit from running Reviewcheck with the `--refresh` option. It will
check for new review data at a regular interval of your choosing. For example.
if you run `reviewcheck --refresh 10`, you will get a new report every 10
minutes. You can even keep Reviewcheck running in the background this way,
since you get desktop notifications any time there is a new message that needs
your attention.</dd>
</dl>
## Support
For support or other queries, contact project owner [Simon
Bengtsson](mailto:simon.bengtsson.3@volvocars.com) or project maintainer [Pontus
Laos](mailto:pontus.laos@volvocars.com).
## Contributing
See the [contributing guide](CONTRIBUTING.md) for detailed instructions on how to get
started with this project.
## Code of Conduct
This project adheres to the [Code of Conduct](./.github/CODE_OF_CONDUCT.md). By
participating, you are expected to honor this code.
## License
This repository is licensed under [Apache License 2.0](LICENSE) © 2022 Volvo Cars.
Raw data
{
"_id": null,
"home_page": "https://github.com/volvo-cars/Reviewcheck",
"name": "reviewcheck",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1",
"maintainer_email": "",
"keywords": "code review,gitlab",
"author": "Simon Bengtsson",
"author_email": "simon.bengtsson.3@volvocars.com",
"download_url": "https://files.pythonhosted.org/packages/2d/98/a6045652d332c1f1205d76db29abfe742aaecc16c5c2744408c60f5f0d7e/reviewcheck-0.7.0.tar.gz",
"platform": null,
"description": "\n\n# Reviewcheck\n\nReviewcheck is a tool to stay up to date with your reviews on GitLab. You can\nconfigure it to use any GitLab instance you have access to. The tool checks all\nopen merge requests in the repositories chosen by you, and lets you know if\nthere are open threads that need your attention.\n\nReviewcheck is in active development.\n\n## Installation\n\nReviewcheck depends on Python >=3.8.1. There are multiple ways to install it.\nThe simplest is with `pipx`.\n\n### With `pipx`\n\nReviewcheck can be installed with the following command:\n\n```console\n$ pipx install reviewcheck\n```\n\n### With Poetry\n\nIf you are a developer, the best way to test changes you make without having to\ncreate a Python package and install it is to clone the repository and run\n`poetry run reviewcheck` from within it. You will need to have poetry\ninstalled. The process looks as follows:\n\n```console\n$ pipx install poetry\n$ git clone https://github.com/volvo-cars/Reviewcheck\n$ cd reviewcheck\n$ poetry install\n$ poetry run reviewcheck\n```\n\n### With Docker\n\nThere's also a Dockerfile available to use. Currently it does not get uploaded\nanywhere, so you'll need to build it locally and then run it. Example commands:\n\n```console\n$ docker build -t reviewcheck .\n$ docker run -tv ~/.config/reviewcheckrc:/root/.config/reviewcheckrc reviewcheck\n```\n\n## Getting Started\n\nReviewcheck has a terminal-based user interface. You run it on the command line\nwith `reviewcheck`. The first time you run it, you will be able to\ninteractively configure it to find your reviews.\n\nAfter that, any time you run `reviewcheck`, you will be presented with a list\nof threads from any MR where your response is needed. You can configure how\nverbose the output is with options. See the `--help` option for more information\nabout that.\n\nWhenever there is a new review comment that wasn't present the last time\nReviewcheck fetched comments, you will receive a desktop notification. An\nexample:\n\n\n\nNotifications are sent using `notify-send` so the notification should look like\nany other desktop notification on your system. They will likely differ in\nvisual appearance from the example image.\n\n### Configuration\n\nThe first time you run Reviewcheck, the interactive configuration will start. If\nyou ever want to reconfigure it, just run `reviewcheck configure`. You can also\nmodify the configuration file directly. Unless you configured a separate\nconfigurations directory, it should be in `~/.config/reviewcheckrc`.\n\nYou will be asked for an access token. It can be created in your GitLab\nsettings, under \"User settings\" > \"Access Token\". It should have at least the\n`read_api` access.\n\nYou will also be asked for your \"GitLab URL\". For the main GitLab instance, it\nwould be `https://gitlab.com` but if you have your own instance, use that\ninstead. Do not add a slash at the end.\n\nThere is the possibility to add a Jira base URL. It is used if you have Jira\nticket referenced in your commits. An example would be\n`https://jira.example.com`.\n\nFinally, you should fill in the project IDs of projects where you want to track\nmerge requests. This can be a bit tricky to find and you might need to consult\nthe GitLab documentation. It may be under the title of your repository. It may\nalso be to the right of the title, under the three-dots menu.\n\nAfter that, you're all set.\n\n## FAQ\n\n<dl>\n <dt>How do I configure Reviewcheck?</dt>\n <dd>The first time you run `reviewcheck`, the interactive configuration will\n start. You can rerun it with `reviewcheck configure`. If you know what you're\n doing, you may also edit the configuration file directly. You'll find the\n configuration file `reviewcheckrc` in your configuration files directory,\n usually `~/.config/`.</dd>\n\n <dt>Will you support other software hosting pages than GitLab?</dt>\n <dd>Yes! We hope to support Gerrit in the near future and Gitea and GitHub in the\n far future.</dd>\n\n <dt>What triggers the desktop notifications?</dt>\n <dd>When Reviewcheck is run and a new message is discovered in a thread that\n Reviewcheck judges you should respond to, you will get a desktop notification\n containing the new message. This may be useful when you're running in a loop\n with the `--refresh` option.</dd>\n\n <dt>Why are you asking for a JIRA URL?</dt>\n <dd>This is only relevant if your organization uses JIRA and tags merge requests\n with the JIRA ticket number. It will help Reviewcheck provide you with a link\n to the ticket connected to the merge request. Please report a bug if your\n organization uses JIRA but the current system doesn't work for you.</dd>\n\n <dt>How can I get regular updates without having to remember to run Reviewcheck?</dt>\n <dd>You may benefit from running Reviewcheck with the `--refresh` option. It will\n check for new review data at a regular interval of your choosing. For example.\n if you run `reviewcheck --refresh 10`, you will get a new report every 10\n minutes. You can even keep Reviewcheck running in the background this way,\n since you get desktop notifications any time there is a new message that needs\n your attention.</dd>\n</dl>\n\n## Support\n\nFor support or other queries, contact project owner [Simon\nBengtsson](mailto:simon.bengtsson.3@volvocars.com) or project maintainer [Pontus\nLaos](mailto:pontus.laos@volvocars.com).\n\n## Contributing\n\nSee the [contributing guide](CONTRIBUTING.md) for detailed instructions on how to get\nstarted with this project.\n\n## Code of Conduct\n\nThis project adheres to the [Code of Conduct](./.github/CODE_OF_CONDUCT.md). By\nparticipating, you are expected to honor this code.\n\n## License\n\nThis repository is licensed under [Apache License 2.0](LICENSE) \u00a9 2022 Volvo Cars.\n",
"bugtrack_url": null,
"license": "Apache-2.0 license",
"summary": "Tool to stay up to date with your reviews on GitLab \u2013 Don't let a comment slip you by",
"version": "0.7.0",
"project_urls": {
"Homepage": "https://github.com/volvo-cars/Reviewcheck"
},
"split_keywords": [
"code review",
"gitlab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f1d8414c492d450a3c6197f0925e89ddfabe11a4b6caf5a7d33ce2c8fc52d3e5",
"md5": "d3805cbb495eee81d07110f84ff560ab",
"sha256": "62a75823f6d0145924cf9056276c8f49341e2cbf08fdffb2308f0c8089af249a"
},
"downloads": -1,
"filename": "reviewcheck-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3805cbb495eee81d07110f84ff560ab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1",
"size": 21958,
"upload_time": "2024-01-24T15:36:08",
"upload_time_iso_8601": "2024-01-24T15:36:08.487387Z",
"url": "https://files.pythonhosted.org/packages/f1/d8/414c492d450a3c6197f0925e89ddfabe11a4b6caf5a7d33ce2c8fc52d3e5/reviewcheck-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2d98a6045652d332c1f1205d76db29abfe742aaecc16c5c2744408c60f5f0d7e",
"md5": "74bfcf558ce4e9498faecc773ba44fff",
"sha256": "c774403ff34b2cfb501e7c3fa507e2df62cdf8e1f59e1c2c78c0d788737575db"
},
"downloads": -1,
"filename": "reviewcheck-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "74bfcf558ce4e9498faecc773ba44fff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1",
"size": 20011,
"upload_time": "2024-01-24T15:36:09",
"upload_time_iso_8601": "2024-01-24T15:36:09.635343Z",
"url": "https://files.pythonhosted.org/packages/2d/98/a6045652d332c1f1205d76db29abfe742aaecc16c5c2744408c60f5f0d7e/reviewcheck-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-24 15:36:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "volvo-cars",
"github_project": "Reviewcheck",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "reviewcheck"
}
JSON
