Metadata-Version: 2.1
Name: reviews
Version: 0.1.0
Summary: Code Review Manager written in Python. Standalone client included.
Home-page: https://github.com/apoclyps/code-review-manager
Author: Kyle Harrison
Author-email: kyle.harrison.dev@gmail.com
License: MIT
Download-URL: https://github.com/apoclyps/code-review-manager/archive/0.1.0.tar.gz
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:
        
        ```bash
        # 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](https://asciinema.org/a/LEs7tltVE3guhsLEEFGc5FDiD.svg)](https://asciinema.org/a/LEs7tltVE3guhsLEEFGc5FDiD)
        
        ### 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`:
        
        ```bash
        $ 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:
        
        ```bash
        $ 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:
        
        ```bash
        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:
        
        ```bash
        $ 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:
        
        ```bash
        $ pytest -vvv
        ```
        
        Alternatively, to run a single set of tests.
        
        ```bash
        $ pytest -vvv tests/test_config.py
        ```
        
        All tests can be run within docker by using the following command:
        
        ```bash
        $ 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](.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
        
Keywords: code review manager,pull request review
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
