Code Review Manager written in Python. Standalone client included.
Project description
Reviews
Simplify code review with an all-in-one TUI dashboard providing an overview of open PRs requiring review!
Quick Start
If you want to get up and running with Code Review Manager immediately, run:
export GITHUB_USER="your-github-username"
export GITHUB_TOKEN="your personal github token used for interacting with the API"
export REPOSITORY_CONFIGURATION="apoclyps/code-review-manager"
pip install --upgrade reviews
reviews dashboard
Getting started with local development
To build and run the CLI on your host, you will need Python 3.9, pip, and virtualenv to build and run review
:
$ python3 -m venv env
$ source env/bin/activate
(env)$ pip install -r requirements_dev.txt
(env)$ pip install -r requirements.txt
(env)$ python cli.py dashboard
If you wish to keep a copy of code review manager on your host system forever, you can install and run it using:
$ export ENABLE_NOTIFICATIONS=true
$ export ENABLE_PERSISTED_DATA=false
$ export REPOSITORY_CONFIGURATION="apoclyps/code-review-manager"
$ pip install -e .
$ reviews dashboard
You can run the code review manager within Docker:
docker-compose build cli && docker-compose run --rm cli python cli.py dashboard
To build an image and run that image with all of the necessary dependencies using the following commands:
$ docker-compose build cli
$ docker-compose run --rm cli python cli.py dashboard
For instructions on setting up a development enviroment outside of Docker, checkout the wiki.
Testing
A test suite has been included to ensure Code Review Manager functions correctly:.
To run the entire test suite with verbose output, run the following:
$ pytest -vvv
Alternatively, to run a single set of tests.
$ pytest -vvv tests/test_config.py
All tests can be run within docker by using the following command:
$ docker-compose build pytest && docker-compose run --rm pytest
Linting
To run individual linting steps:
docker-compose build
docker-compose run --rm black
docker-compose run --rm flake8
docker-compose run --rm isort
docker-compose run --rm mypy
docker-compose run --rm pylint
Contributions
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.