Mercurial > daily-edition
annotate README.txt @ 23:8b501dfe7d85
changed names of cmd line options to make a bit more sense
| author | Atul Varma <varmaa@toolness.com> |
|---|---|
| date | Sun, 03 Jan 2010 05:01:38 -0800 |
| parents | 75e573ddc70e |
| children | 000d59466d43 |
| rev | line source |
|---|---|
|
13
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
1 Description |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
2 ----------- |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
3 |
| 0 | 4 The Daily Edition is created anew each morning. It contains a number |
| 5 of articles from a variety of RSS feeds. | |
| 6 | |
|
13
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
7 Quick Start |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
8 ----------- |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
9 |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
10 (1) Create a file called 'authors.txt' which contains the full |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
11 name of an author on each line. The authors should be listed |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
12 in order of importance to the reader. Each author should |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
13 have an entry on whoisi.com. |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
14 |
| 18 | 15 (2) Run 'python publish_edition.py -w'. |
|
13
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
16 |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
17 (3) Open daily-edition.html in a web browser. |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
18 |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
19 Additional Notes |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
20 ---------------- |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
21 |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
22 NOTE: Not all of this is implemented! |
|
69fd13a4aef4
Added an html viewer and a publish_edition.py script that generates the JSON which the html viewer reads.
Atul Varma <varmaa@toolness.com>
parents:
0
diff
changeset
|
23 |
| 0 | 24 Each issue can only contain a maximum number of articles, as |
| 25 specified by the reader. Optionally, the reader may also specify | |
| 26 a maximum number of articles by the same author, to ensure | |
| 27 diversity of sources. | |
| 28 | |
| 29 The RSS feeds drawn from each issue are found by querying whoisi.com | |
| 30 for the names of various individuals called "influencers", which are | |
| 31 an ordered list provided by the reader. The list is ordered from | |
| 32 "most influential" to "least influential". | |
| 33 | |
| 34 The program creating each issue is "aware" of what previous issues | |
| 35 have contained, so as to ensure that no two issues have the same | |
| 36 article. | |
| 37 | |
| 38 Whether an influencer's article is included in an issue should take | |
| 39 into account: | |
| 40 | |
| 41 * Influence | |
| 42 the author's rank, from 0 (highest) to [of authors] (lowest). | |
| 43 (lower -> higher likelihood of inclusion) | |
| 44 | |
| 45 * Recency | |
| 46 time passed since the article was first written. | |
| 47 (more recent -> higher likelihood of inclusion) | |
| 48 | |
| 49 * Diversity | |
| 50 time passed since the author was last featured in an issue. | |
| 51 (less recent -> higher likelihood of inclusion) | |
| 52 | |
| 53 data stores: | |
| 54 | |
| 55 * a collection of AUTHORS, each AUTHOR has a NAME and RANK. The | |
| 56 NAME is a unique identifier. | |
| 57 | |
| 58 * a collection of ARTICLES, each ARTICLE has an AUTHOR, TITLE, DATE, | |
| 59 CONTENT, and URL. The URL is a unique identifier. | |
| 60 | |
| 61 * a collection of ISSUES, each ISSUE has a NUMBER, DATE and a list | |
| 62 of ARTICLES. The NUMBER is a unique identifier. |