README.md - Issue 29359949: Noissue - Add README [buildtools]

Keyboard Shortcuts

	File
u :	up to issue
m :	publish + mail comments
M :	edit review message
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line
<Enter> :	respond to / edit current comment
d :	mark current comment as done

	Issue
u :	up to list of issues
m :	publish + mail comments
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue
# :	close issue

	Comment/message editing
<Ctrl> + s or <Ctrl> + Enter :	save comment
<Esc> :	cancel edit

Delta Between Two Patch Sets: README.md

Issue 29359949: Noissue - Add README [buildtools] (Closed)

Left Patch Set: Created Oct. 26, 2016, 2:59 p.m.

Right Patch Set: Don't bother document how to install Tox Created Oct. 27, 2016, 3:13 p.m.

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

Left: Side by side diff | Download
Right: Side by side diff | Download

LEFT	RIGHT
1 # Buildtools	1 # Buildtools

2	2

3 ## Introduction	3 ## Introduction

4	4

5 Tools used to produce builds and releases of the Adblock Plus browser	5 Tools used to produce builds and releases of the Adblock Plus browser

6 extensions. Intended to be used as a dependency by the extension repositories,	6 extensions. Intended to be used as a dependency by the extension repositories,

7 not directly.	7 not directly.

8	8

9	9

10 ## Usage	10 ## Usage

11	11

12 Please refer to the documentation of the extension repositories for usage	12 Please refer to the documentation of the extension repositories for usage

13 instructions	13 instructions.
Vasily Kuznetsov 2016/10/26 16:15:34 Nit: period at the end of the sentence. Nit: period at the end of the sentence. kzar 2016/10/26 16:24:48 Done. Show quoted text On 2016/10/26 16:15:34, Vasily Kuznetsov wrote: > Nit: period at the end of the sentence. Done.
14	14

15	15

16 ## Tests	16 ## Tests

17	17

18 As per the [Python Coding Style guide](https://adblockplus.org/en/coding-style#p ython)	18 As per the [Python Coding Style guide](https://adblockplus.org/en/coding-style#p ython)

19 this repository can be linted and tested using [Tox](https://pypi.python.org/pyp i/tox).	19 this repository can be linted and tested using [Tox](https://pypi.python.org/pyp i/tox).

20	20

21 First install flake8, flake8-abp and tox:	21 Once [Tox is installed](https://tox.readthedocs.io/en/latest/install.html) it's
Vasily Kuznetsov 2016/10/26 16:15:34 It should not be necessary to install flake8 globa It should not be necessary to install flake8 globally in order to run the tests with Tox. Tox installs it automatically inside of the virtualenv that it creates for testing. Same for flake8-abp. So the only thing that is needed is tox itself. kzar 2016/10/26 16:24:48 Cool. Done. Show quoted text On 2016/10/26 16:15:34, Vasily Kuznetsov wrote: > It should not be necessary to install flake8 globally in order to run the tests > with Tox. Tox installs it automatically inside of the virtualenv that it creates > for testing. Same for flake8-abp. So the only thing that is needed is tox > itself. Cool. Done.
22	22 easy to lint and run the tests:

23 hg clone https://hg.adblockplus.org/codingtools

24 cd codingtools

25 sudo python setup.py install

26 sudo pip install flake8 tox

27

28 Now you can lint and test the code by running the tox command:

29	23

30 tox	24 tox

	25

	26 _(Tox will take care of installing the other dependencies such as flake8 and

	27 flake8-abp inside a virtualenv.)_

LEFT	RIGHT