Skip to content

Latest commit

 

History

History
221 lines (147 loc) · 5.58 KB

README.rst

File metadata and controls

221 lines (147 loc) · 5.58 KB
Raw

CodeReview

CodeReview license CodeReview python version

CodeReview last version

CodeReview Home Page is located at http://fabricesalvaire.github.io/CodeReview

https://raw.github.com/FabriceSalvaire/CodeReview/master/doc/sphinx/source/images/code-review-log.png

https://raw.github.com/FabriceSalvaire/CodeReview/master/doc/sphinx/source/images/code-review-diff.png

Credits

Authors: Fabrice Salvaire

News

V1 2017-12-20

  • Redesigned INotify support

Introduction

The aim of CodeReview is to provide tools for code review tasks on local Git repositories. As opposite to software like Gerrit for example, CodeReview is not designed to perform code review at a team level, but to check the stage before a commit and show the difference between two versions. In particular, CodeReview fills the gap with IDEs that don't provide efficiently these features.

How to use CodeReview ?

CodeReview provides two applications pyqgit and diff-viewer.

Features

The main features of CodeReview are:

  • display and browse the log and paches of a Git repository
  • diff side by side using Patience algorithm
  • watch for file system changes

Diff viewer features:

  • stage/unstage file
  • number of context lines
  • font size
  • line number mode
  • align mode
  • complete mode
  • highlight mode

Installation

On Fedora

RPM packages are available for the Fedora distribution on https://copr.fedorainfracloud.org/coprs/fabricesalvaire/code-review

Run these commands to enable the copr repository and install the last release:

dnf copr enable fabricesalvaire/code-review
dnf install CodeReview

From PyPi Repository

CodeReview is available on PyPI repository: https://pypi.python.org/pypi/CodeReview

Run this command to install the last release:

pip install CodeReview

Notice, it requires Python 3 and a C compiler.

From source

CodeReview source code is hosted at https://github.com/FabriceSalvaire/CodeReview

Clone the Git repository using this command:

git clone [email protected]:FabriceSalvaire/CodeReview.git

Then build and install CodeReview using these commands:

python setup.py build
python setup.py install

Dependencies

CodeReview requires the following dependencies:

  • Python 3 (at least v3.4)
  • pygit2 and libgit2 see link for installation instruction
  • Pygments
  • PyQt5
  • PyYAML
  • A C compiler to compile a module

How to help

  • test it on Windows and OSX
  • fix bugs: look at issues
  • sometime pyqgit is slow: profile code to find issues