CodeReview/README.html at master · pythoningLearning/CodeReview · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
<title></title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden;
}

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left, object.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right, object.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: inherit }

/* div.align-center * { */
/*   text-align: left } */

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block, pre.math, pre.code {
  margin-left: 2em ;
  margin-right: 2em }

pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
  border: 0px;
  border-top: 2px solid;
  border-bottom: 2px solid;
  border-collapse: collapse;
}
table.docutils.booktabs * {
  border: 0px;
}
table.docutils.booktabs th {
  border-bottom: thin solid;
  text-align: left;
}

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document">


<!-- -*- Mode: rst -*- -->
<!-- -*- Mode: rst -*- -->
<!-- |CodeReviewUrl|
|CodeReviewHomePage|_
|CodeReviewDoc|_
|CodeReview@github|_
|CodeReview@readthedocs|_
|CodeReview@readthedocs-badge|
|CodeReview@pypi|_ -->
<!-- .. _CodeReview@github: https://github.com/FabriceSalvaire/CodeReview -->
<!-- .. _CodeReview@readthedocs: http://CodeReview.readthedocs.org -->
<!-- .. _CodeReview@pypi: https://pypi.python.org/pypi/CodeReview -->
<!-- End -->
<!-- -*- Mode: rst -*- -->
<!-- End -->
<div class="section" id="codereview">
<h1>CodeReview</h1>
<p>The official CodeReview home page is located at <a class="reference external" href="http://fabricesalvaire.github.io/CodeReview">http://fabricesalvaire.github.io/CodeReview</a></p>
<p>The latest documentation built from the git repository is available at readthedocs.org <a class="reference external" href="http://CodeReview.readthedocs.org/en/latest"><img alt="CodeReview&#64;readthedocs-badge" src="https://readthedocs.org/projects/CodeReview/badge/?version=latest" /></a></p>
<p>Written by <a class="reference external" href="http://fabrice-salvaire.pagesperso-orange.fr">Fabrice Salvaire</a>.</p>
<p><a class="reference external" href="https://travis-ci.org/FabriceSalvaire/CodeReview"><img alt="CodeReview build status &#64;travis-ci.org" src="https://travis-ci.org/FabriceSalvaire/CodeReview.svg?branch=master" /></a></p>
<img alt="https://raw.github.com/FabriceSalvaire/CodeReview/master/doc/sphinx/source/images/code-review-log.png" src="https://raw.github.com/FabriceSalvaire/CodeReview/master/doc/sphinx/source/images/code-review-log.png" />
<img alt="https://raw.github.com/FabriceSalvaire/CodeReview/master/doc/sphinx/source/images/code-review-diff.png" src="https://raw.github.com/FabriceSalvaire/CodeReview/master/doc/sphinx/source/images/code-review-diff.png" />
<hr class="docutils" />
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="introduction">
<h1>Introduction</h1>
<p>I started to write some pieces of code of CodeReview at the end of 2011, as a port of the Bzr Qt
plugin <a class="reference external" href="http://wiki.bazaar.canonical.com/QBzr">QBzr</a> for Git when Bzr started to seriously fall
down.  I am an addict of code review and I cannot work without it.  QBzr features two nice tools,
qlog and qdiff for this task.  It was the main reason why I am still using Bzr in 2015.  But now I
succeed to release an alternative.</p>
<p>The aim of CodeReview is to provide tools for code review tasks, like to show the difference between
two versions.  However I am not a fan of any GUI that aims to deal with Git with only a mouse and
one finger.  Thus CodeReview is not intended to compete with a &quot;power&quot; IDE like eclipse, idea,
pycharm, kate ...  But just to provide features not available in Emacs (my editor) or github like a
diff side-by-side on local changes.</p>
<p>CodeReview is written in Python 3 and the GUI is based on the Qt5 framework.  The libgit2 and
<a class="reference external" href="http://www.pygit2.org/install.html">pygit2</a> provides a Python API to deal with Git repositories.  I tried to achieve a clever design
and to write a clean code.</p>
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="features">
<h1>Features</h1>
<p>The main features of CodeReview are:</p>
<blockquote>
<ul class="simple">
<li>display and browse the log and paches of a Git repository</li>
<li>diff side by side using Patience algorithm</li>
</ul>
</blockquote>
<p>Diff viewer features:</p>
<blockquote>
<ul class="simple">
<li>number of context lines</li>
<li>font size</li>
<li>line number mode</li>
<li>align mode</li>
<li>complete mode</li>
<li>highlight mode</li>
</ul>
</blockquote>
<!-- end -->
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="ideas-for-additional-features">
<h1>Ideas for Additional Features</h1>
<p>Actually CodeReview has a limited number of features.  The followings list gives some ideas to extend its
features:</p>
<blockquote>
<ul class="simple">
<li>Add Mercurial support. (Git and Mercurial are actually the most cool VCS)</li>
<li>Add a graphical representation of the branches.  I don't understand the crappy code of qlog and I
don't know any algorithm on this topic (graphviz, qgit ?).  To summarize I don't what and how to do.</li>
<li>Implement the detection of code translocations.  Sometimes we move code within a file or a
project.  Such changes are related as deletion and addition in the code, which don't help to
review code.  We can do something clever by computing a distance between all the added and
deleted chuncks.  The distance could be computed using a Levenshtein, Damerau–Levenshtein,
Needleman–Wunsch or Smith–Waterman algorithm (DNA alignment algorithms).</li>
<li>Implement code analyser/validator as language plugins.  The idea is to annotate change as
cosmetic or dangerous modifications.  For example a deleted or added space is a cosmetic change
in C, but it can be a regression in Python where the indentation is part of the grammar.</li>
<li>Implement blame wich is another important feature.</li>
<li>Implement comments and maybe as a client-server architecture.</li>
<li>look <a class="reference external" href="https://docs.python.org/3.4/library/difflib.html">https://docs.python.org/3.4/library/difflib.html</a></li>
</ul>
</blockquote>
<!-- end -->
<!-- End -->
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="installation">
<span id="installation-page"></span><h1>Installation</h1>
<p>CodeReview requires some dependencies wich are easier to install on a Linux distribution.</p>
<div class="section" id="dependencies">
<h2>Dependencies</h2>
<p>CodeReview requires the following dependencies:</p>
<blockquote>
<ul class="simple">
<li><a class="reference external" href="http://python.org">Python</a> v3.4</li>
<li><a class="reference external" href="http://www.riverbankcomputing.com/software/pyqt/download5">PyQt5</a> v5.4</li>
<li>libgit2 see <a class="reference external" href="http://www.pygit2.org/install.html#quick-install">link</a>  for installation instruction</li>
</ul>
</blockquote>
<p>Theses packages are available via <a class="reference external" href="https://python-packaging-user-guide.readthedocs.org/en/latest/projects.html#pip">pip</a>:</p>
<blockquote>
<ul class="simple">
<li><a class="reference external" href="http://www.pygit2.org/install.html">pygit2</a></li>
<li>Pygments</li>
<li>PyYAML</li>
</ul>
</blockquote>
<p>For development, you will need in addition:</p>
<blockquote>
<ul class="simple">
<li><a class="reference external" href="http://sphinx-doc.org">Sphinx</a></li>
</ul>
</blockquote>
</div>
<div class="section" id="installation-from-pypi-repository">
<h2>Installation from PyPi Repository</h2>
<p>CodeReview is made available on the <a class="reference external" href="https://pypi.python.org/pypi">PyPI</a> repository at <a class="reference external" href="https://pypi.python.org/pypi/CodeReview">https://pypi.python.org/pypi/CodeReview</a></p>
<p>Run this command to install the last release:</p>
<pre class="code sh literal-block">
pip install CodeReview
</pre>
</div>
<div class="section" id="installation-from-source">
<h2>Installation from Source</h2>
<p>The CodeReview source code is hosted at <a class="reference external" href="https://github.com/FabriceSalvaire/CodeReview">https://github.com/FabriceSalvaire/CodeReview</a></p>
<p>To clone the Git repository, run this command in a terminal:</p>
<pre class="code sh literal-block">
git clone git&#64;github.com:FabriceSalvaire/CodeReview.git
</pre>
<p>Then to build and install CodeReview run these commands:</p>
<pre class="code sh literal-block">
python setup.py build
python setup.py install
</pre>
<!-- End -->
<!-- End -->
</div>
</div>
</div>
</body>
</html>