OLD | NEW |
1 # python-abp | 1 # python-abp |
2 | 2 |
3 This repository contains a library for working with Adblock Plus filter lists | 3 This repository contains a library for working with Adblock Plus filter lists |
4 and the script that is used for building Adblock Plus filter lists from the | 4 and the script that is used for building Adblock Plus filter lists from the |
5 form in which they are authored into the format suitable for consumption by the | 5 form in which they are authored into the format suitable for consumption by the |
6 adblocking software. | 6 adblocking software. |
7 | 7 |
8 ## Installation | 8 ## Installation |
9 | 9 |
10 Prerequisites: | 10 Prerequisites: |
(...skipping 70 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
81 | 81 |
82 $ flrender easylist.txt output/easylist.txt | 82 $ flrender easylist.txt output/easylist.txt |
83 Unknown source: 'easylist' when including 'easylist:easylist/easylist_gener | 83 Unknown source: 'easylist' when including 'easylist:easylist/easylist_gener |
84 al_block.txt' from 'easylist.txt' | 84 al_block.txt' from 'easylist.txt' |
85 | 85 |
86 You can clone the necessary repositories to a local directory and add `-i` | 86 You can clone the necessary repositories to a local directory and add `-i` |
87 options accordingly. | 87 options accordingly. |
88 | 88 |
89 ## Rendering diffs | 89 ## Rendering diffs |
90 | 90 |
91 A diff allows a client running ad blocking software such as Adblock Plus to upda
te | 91 A diff allows a client running ad blocking software such as Adblock Plus to |
92 the filter lists incrementally, instead of downloading a new copy of a full list | 92 update the filter lists incrementally, instead of downloading a new copy of a |
93 during each update. This is meant to lessen the amount of resources used when up
dating | 93 full list during each update. This is meant to lessen the amount of resources |
94 filter lists (e.g. network data, memory usage, battery consumption, etc.), allow
ing | 94 used when updating filter lists (e.g. network data, memory usage, battery |
95 clients to update their lists more frequently using less resources. | 95 consumption, etc.), allowing clients to update their lists more frequently using |
| 96 less resources. |
96 | 97 |
97 Python-abp contains a script that produces the diff between two versions of a | 98 Python-abp contains a script called `fldiff` that will find the diff between the |
98 filter list called `fldiff`: | 99 latest filter list, and any number of previous filter lists: |
99 | 100 |
100 $ fldiff base.txt latest.txt output.txt | 101 $ fldiff -o diffs/easylist easylist.txt archive/* |
| 102 where `-o diffs/easylist` is the (optional) output directory where the diffs |
| 103 should be written, `-l easylist.txt` is the most recent version of the |
| 104 filter list, and `archive/*` is the directory where all the the archived filter |
| 105 lists are. When called like this, the shell should automatically expand the |
| 106 `archive/*` directory, giving the script each of the files separately. |
101 | 107 |
102 This will produce a diff that shows how a client may get from `base.txt` to | 108 The output of each `list[version].txt` will be written to |
103 `latest.txt`, and write the output to `output.txt`. The output argument is | 109 `diffs/diff[version].txt`. The output argument is optional. If ommitted, the |
104 optional. If ommitted, the data will be written to `stdout`. | 110 diffs will be written to the current directory. |
105 | 111 |
106 The script produces three types of lines, as specified in the [technical specifi
cation][5]: | 112 The script produces three types of lines, as specified in the [technical |
| 113 specification][5]: |
107 * Special comments of the form `! <name>:[ <value>]` | 114 * Special comments of the form `! <name>:[ <value>]` |
108 * Added filters of the form `+ <filter-text>` | 115 * Added filters of the form `+ <filter-text>` |
109 * Removed filter of the form `- <filter-text>` | 116 * Removed filters of the form `- <filter-text>` |
| 117 |
110 | 118 |
111 ## Library API | 119 ## Library API |
112 | 120 |
113 Python-abp can also be used as a library for parsing filter lists. For example | 121 Python-abp can also be used as a library for parsing filter lists. For example |
114 to read a filter list (we use Python 3 syntax here but the API is the same): | 122 to read a filter list (we use Python 3 syntax here but the API is the same): |
115 | 123 |
116 from abp.filters import parse_filterlist | 124 from abp.filters import parse_filterlist |
117 | 125 |
118 with open('filterlist.txt') as filterlist: | 126 with open('filterlist.txt') as filterlist: |
119 for line in parse_filterlist(filterlist): | 127 for line in parse_filterlist(filterlist): |
(...skipping 78 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
198 | 206 |
199 Now you can use the functions with `abp$functionname`, e.g. | 207 Now you can use the functions with `abp$functionname`, e.g. |
200 `abp.line2dict("@@||g.doubleclick.net/pagead/$subdocument,domain=hon30.org")` | 208 `abp.line2dict("@@||g.doubleclick.net/pagead/$subdocument,domain=hon30.org")` |
201 | 209 |
202 | 210 |
203 [1]: https://adblockplus.org/filters#special-comments | 211 [1]: https://adblockplus.org/filters#special-comments |
204 [2]: http://pytest.org/ | 212 [2]: http://pytest.org/ |
205 [3]: https://tox.readthedocs.org/ | 213 [3]: https://tox.readthedocs.org/ |
206 [4]: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt | 214 [4]: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt |
207 [5]: https://docs.google.com/document/d/1SoEqaOBZRCfkh1s5Kds5A5RwUC_nqbYYlGH72s
bsSgQ/ | 215 [5]: https://docs.google.com/document/d/1SoEqaOBZRCfkh1s5Kds5A5RwUC_nqbYYlGH72s
bsSgQ/ |
OLD | NEW |