Skip to main content

Suggest reviewers for your git branch

Project description

git-reviewers
=============

|PyPI| |PyPI|

|Codeship Status for albertyw/git-reviewers| |Dependency Status| |Code
Climate| |Test Coverage|

Tool to suggest code reviewers for your code depending on your diff

Installation
------------

You need to first clone this repository somewhere on your system
(perhaps in your `dotfiles <https://github.com/albertyw/dotfiles>`__)
repository.

.. code:: bash

git clone git@github.com:albertyw/git-reviewers $REPOSITORY_LOCATION
git config --global \
alias.reviewers \
"!"$REPOSITORY_LOCATION"/git_reviewers/reviewers.py --path=\${GIT_PREFIX:-./}"

Usage
-----

::

Usage: git reviewers [-h] [--path PATH] [--uber]

If ``--path`` is called, then its value is be used to compute the
relative path to the current git repository If ``--uber`` is called,
then the reviewers lookup and output will be compatible with Uber

Development
-----------

.. code:: bash

pip install -r requirements-test.txt
coverage run setup.py test
coverage report
flake8

Publishing
----------

.. code:: bash

sudo apt-get install pandoc
pip install twine pypandoc
python setup.py sdist bdist_wheel
twine upload dist/*

.. |PyPI| image:: https://img.shields.io/pypi/v/git-reviewers.svg
:target: https://github.com/albertyw/git-reviewers
.. |PyPI| image:: https://img.shields.io/pypi/pyversions/git-reviewers.svg
:target:
.. |Codeship Status for albertyw/git-reviewers| image:: https://app.codeship.com/projects/17913cd0-3524-0135-2853-7e1f21584d06/status?branch=master
:target: https://app.codeship.com/projects/227040
.. |Dependency Status| image:: https://gemnasium.com/badges/github.com/albertyw/git-reviewers.svg
:target: https://gemnasium.com/github.com/albertyw/git-reviewers
.. |Code Climate| image:: https://codeclimate.com/github/albertyw/git-reviewers/badges/gpa.svg
:target: https://codeclimate.com/github/albertyw/git-reviewers
.. |Test Coverage| image:: https://codeclimate.com/github/albertyw/git-reviewers/badges/coverage.svg
:target: https://codeclimate.com/github/albertyw/git-reviewers/coverage

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

git-reviewers-0.1.0.tar.gz (3.6 kB view hashes)

Uploaded Source

Built Distribution

git_reviewers-0.1.0-py3-none-any.whl (5.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