Metadata-Version: 2.1
Name: reviews
Version: 0.2.2
Summary: A terminal UI dashboard to monitor requests for code review across Github repositories.
Home-page: https://reviews-cli.dev/
Author: Kyle Harrison
Author-email: kyle.harrison.dev@gmail.com
License: MIT
Download-URL: https://pypi.org/project/reviews/
Project-URL: Funding, https://ko-fi.com/apoclyps
Project-URL: Say Thanks!, https://twitter.com/apoclyps
Project-URL: Source, https://github.com/apoclyps/reviews
Project-URL: Tracker, https://github.com/apoclyps/reviews/issues
Description: # Reviews
        
        [![Tests](https://github.com/apoclyps/reviews/actions/workflows/test.yml/badge.svg)](https://github.com/apoclyps/reviews/actions/workflows/test.yml)
        ![pypi](https://img.shields.io/pypi/v/reviews.svg)
        ![versions](https://img.shields.io/pypi/pyversions/reviews.svg)
        
        ![](https://banners.beyondco.de/Reviews.png?theme=light&packageManager=pip+install&packageName=reviews&pattern=plus&style=style_1&description=Monitor+requests+for+Code+Reviews&md=1&showWatermark=0&fontSize=225px&images=link&widths=250)
        
        Simplify requests for 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 Reviews immediately, run:
        
        ```bash
        export GITHUB_USER="your-github-username"
        export GITHUB_TOKEN="your personal GitHub token used for interacting with the API"
        export REVIEWS_REPOSITORY_CONFIGURATION="apoclyps/reviews"
        
        pip install --upgrade reviews
        
        reviews config --show
        
        reviews metrics
        
        reviews dashboard --no-reload
        ```
        
        [![asciicast](https://asciinema.org/a/414444.svg)](https://asciinema.org/a/414444)
        
        ### Additional Support
        
        If you wish to view the configuration used by reviews at any time, you can use the following command to show all configuration (with secrets hidden or shown):
        
        ```bash
        reviews config --hide
        
        reviews config --show
        ```
        
        **Experimental**
        
        The following features have been implemented but support is considered experimental and it may be removed in a future release.
        
        If you wish to use Reviews with a Github Enterprise instead of Github (https://api.github.com", you can set the `GITHUB_URL` with your custom hostname. You will also need to ensure your `GITHUB_USER` and `GITHUB_TOKEN` exist within your Enterprise Github instance:
        
        ```bash
        export GITHUB_URL=https://{hostname}/api/v3
        export GITHUB_USER=user
        export GITHUB_TOKEN=token
        ```
        
        ### 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 -m reviews dashboard
        ```
        
        If you wish to keep a copy of Reviews on your host system, you can install and run it using:
        
        ```bash
        $ export REVIEWS_REPOSITORY_CONFIGURATION="apoclyps/reviews"
        $ python -m venv env
        $ source env/bin/activate
        $ python -m pip install -e .
        $ reviews -h
        ```
        
        You can run the Reviews within Docker:
        
        ```bash
        docker-compose build cli && docker-compose run --rm cli python -m reviews dashboard
        ```
        
        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 -m reviews dashboard
        ```
        
        For instructions on setting up a development environment outside of Docker, check out the [wiki](https://github.com/apoclyps/reviews/wiki/Development-Enviromnent).
        
        ### Configuration
        
        Reviews supports both .ini and .env files. Reviews always searches for Options in this order:
        
        * Environment variables;
        * Repository: ini or .env file;
        * Configuration Path
        * Review Defaults
        
        #### Ini file
        Create a `settings.ini` next to your configuration module in the form:
        
        ```bash
        [settings]
        REVIEWS_REPOSITORY_CONFIGURATION=apoclyps/micropython-by-example
        Note: Since ConfigParser supports string interpolation, to represent the character % you need to escape it as %%.
        ```
        
        #### Env file
        Create a `.env` text file on your repository's root directory in the form:
        
        ```bash
        REVIEWS_REPOSITORY_CONFIGURATION=apoclyps/micropython-by-example
        ```
        
        #### Providing a configuration path
        
        If you wish to set the configuration path to use an `ini` or `.env` file when running the application, you can use the configuration of a specific file by supplying the path to the configuration like so:
        
        ```bash
        export REVIEWS_PATH_TO_CONFIG=/home/apoclyps/workspace/apoclyps
        ```
        
        If at any time, you want to confirm your configuration reflects the file you have provided, you can use `reviews config` to view what current configuration of Reviews.
        
        ### Testing
        
        A test suite has been included to ensure Reviews 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
        ```
        
        You can also set up ``pre-commit`` to run the linting steps automatically during the commit phase,
        the pre-commit pipeline can be set up by running the following command on the project root:
        ```bash
        pre-commit install
        ```
        
        ### Contributions
        
        Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
        
Keywords: Reviews,pull request review
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Terminals
Description-Content-Type: text/markdown
