Skip to main content

Code Review Manager written in Python. Standalone client included.

Project description

Code Review Manager

Simplify code review with an all in one dashboard providing an overview of open PRs !

Quick Start

If you want to get up and running with Code Review Manager immediately, run:

# your personal github token used for interacting with the API
export GITHUB_TOKEN="your-github-token"
# comma seperated list of org/repo
export REPOSITORY_CONFIGURATION="apoclyps/code-review-manager"

pip install reviews

reviews dashboard

asciicast

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

Alternatively, you can also run the code review manager within Docker:

docker-compose build cli && docker-compose run --rm cli python cli.py dashboard

Alternatively, you can use docker 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

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reviews-0.1.0.tar.gz (9.6 kB view hashes)

Uploaded Source

Built Distribution

reviews-0.1.0-py3-none-any.whl (11.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page