diff options
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..6360b69 --- /dev/null +++ b/readme.md | |||
@@ -0,0 +1,45 @@ | |||
1 | A feed processor | ||
2 | ================ | ||
3 | |||
4 | `A feed processor` is a simple Python framework for RSS feeds processing, providing classes with overridable methods | ||
5 | for easy alteration. | ||
6 | |||
7 | It includes `a feed parser`, which parses RSS[0.90:2.0], Atom[0.3:1.0] and CDF feeds into Python objects. | ||
8 | |||
9 | |||
10 | Purposes | ||
11 | -------- | ||
12 | |||
13 | `A feed processor` can be used to programmatically remove advertisements from RSS feeds for instance. | ||
14 | |||
15 | Since it is written in Python, this framework can be embedded in a scriptable RSS reader or used to make short CGI | ||
16 | proxy scripts. | ||
17 | |||
18 | |||
19 | Usage | ||
20 | ----- | ||
21 | |||
22 | The file `example.py` contains an example of a custom feed processor which performs light modifications on a public RSS | ||
23 | feed. | ||
24 | |||
25 | |||
26 | Dependencies | ||
27 | ------------ | ||
28 | |||
29 | `A feed processor` is written in Python 3 and depends on `PyRSS2Gen` and `feedparser`, which are both available as | ||
30 | pip and distros packages. | ||
31 | |||
32 | |||
33 | License | ||
34 | ------- | ||
35 | |||
36 | `A feed processor` is a free software distributed under the terms of the provided GNU Affero General Public License. | ||
37 | |||
38 | |||
39 | TODO list | ||
40 | --------- | ||
41 | |||
42 | - [x] add an example | ||
43 | - [ ] add some documentation | ||
44 | - [ ] make a pip package | ||
45 | - [ ] make distros packages? | ||