Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: README.md

Issue 29762573: Issue 6602 - Introduce watchextensions
Patch Set: Created May 16, 2018, 9:47 a.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « .gitignore ('k') | tests/data/omaha.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 # WatchExtensions
2
3 ## Requirements
4 - [Python](https://www.python.org/) [2.7 | 3.5 | 3.6]
5 - when run with Python2.7, you will need the backport-package for Python3's
6 [configparser](https://pypi.org/project/configparser/)
7 - For running the tests, you will need [tox](http://tox.readthedocs.io/en/lates t/index.html)
8 (tox will take care of installing additional dependecies)
9
10 ## Testing
11
12 To run the tests, simply invoke tox on your command line:
13
14 ```
15 $ tox
16 ```
17
18 ## Configuration
19
20 Configuring the WatchExtensions is done via providing a `watchextensions.ini`
21 in either your home folder, or in `/etc/`. Please refer to
22 [watchextensions.ini.example](./watchextensions.ini.example) for possible
23 contents.
24
25 Please refer to the documentation of the hoster of your choice, in order to
26 determine how to configure writable git repositories.
27
28 ## Usage
29
30 ```
31 $ python watchextensions.py -h
32 usage: watchextensions.py [-h] [-q] [-p] [-k] [-c CONFIG_PATH]
33
34 optional arguments:
35 -h, --help show this help message and exit
36 -q, --quiet Suppress informational output.
37 -p, --push Perfom a PUSH to the tracking repository.
38 -k, --keep-repository
39 Keep the local repository
40 -c CONFIG_PATH, --config-path CONFIG_PATH
41 Absolute path to a custom config file.
42 ```
43
44 On a server, run by a cronjob, you may want to run `watchextensions.py` with
45 the following parameters:
46
47 ```
48 python watchextensions.py --quiet --push
49 ```
50
51 in order to
52 * not write any output, except errors
53 * actually push newly tracked content to the tracking repositories.
54
55 ---
56
57 On your local machine, you will most likely want to run
58 ```
59 $ python watchextensions.py -k
60 ```
61
62 in order to
63 * get informational output
64 * keep the temporary repository, in order to directly examine changes
65 * **not** push any changes to the tracking repository
OLDNEW
« no previous file with comments | « .gitignore ('k') | tests/data/omaha.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld