Compare commits

...

2 Commits

Author SHA1 Message Date
pictuga b290568e14 README: decent line length
Obtained from the output of:
python -m morss --help | cat
2020-09-15 23:01:42 +02:00
pictuga 9ecf856f10 Add :resolve to remove (some?) tracking links 2020-09-15 22:57:52 +02:00
3 changed files with 29 additions and 11 deletions

View File

@ -77,8 +77,11 @@ cases" below is detailed how to pass those arguments to morss.
The list of arguments can be obtained by running `morss --help` The list of arguments can be obtained by running `morss --help`
``` ```
usage: morss [-h] [--format {rss,json,html,csv}] [--search STRING] [--clip] [--indent] [--cache] [--force] [--proxy] [--newest] [--firstlink] [--items XPATH] [--item_link XPATH] usage: morss [-h] [--format {rss,json,html,csv}] [--search STRING] [--clip]
[--item_title XPATH] [--item_content XPATH] [--item_time XPATH] [--nolink] [--noref] [--silent] [--indent] [--cache] [--force] [--proxy] [--newest] [--firstlink]
[--resolve] [--items XPATH] [--item_link XPATH]
[--item_title XPATH] [--item_content XPATH] [--item_time XPATH]
[--nolink] [--noref] [--silent]
url url
Get full-text RSS feeds Get full-text RSS feeds
@ -93,27 +96,38 @@ output:
--format {rss,json,html,csv} --format {rss,json,html,csv}
output format output format
--search STRING does a basic case-sensitive search in the feed --search STRING does a basic case-sensitive search in the feed
--clip stick the full article content under the original feed content (useful for twitter) --clip stick the full article content under the original feed
--indent returns indented XML or JSON, takes more place, but human-readable content (useful for twitter)
--indent returns indented XML or JSON, takes more place, but
human-readable
action: action:
--cache only take articles from the cache (ie. don't grab new articles' content), so as to save time --cache only take articles from the cache (ie. don't grab new
articles' content), so as to save time
--force force refetch the rss feed and articles --force force refetch the rss feed and articles
--proxy doesn't fill the articles --proxy doesn't fill the articles
--newest return the feed items in chronological order (morss ohterwise shows the items by appearing order) --newest return the feed items in chronological order (morss
--firstlink pull the first article mentioned in the description instead of the default link ohterwise shows the items by appearing order)
--firstlink pull the first article mentioned in the description
instead of the default link
--resolve replace tracking links with direct links to articles
(not compatible with --proxy)
custom feeds: custom feeds:
--items XPATH (mandatory to activate the custom feeds function) xpath rule to match all the RSS entries --items XPATH (mandatory to activate the custom feeds function)
--item_link XPATH xpath rule relative to items to point to the entry's link xpath rule to match all the RSS entries
--item_link XPATH xpath rule relative to items to point to the entry's
link
--item_title XPATH entry's title --item_title XPATH entry's title
--item_content XPATH entry's content --item_content XPATH entry's content
--item_time XPATH entry's date & time (accepts a wide range of time formats) --item_time XPATH entry's date & time (accepts a wide range of time
formats)
misc: misc:
--nolink drop links, but keeps links' inner text --nolink drop links, but keeps links' inner text
--noref drop items' link --noref drop items' link
--silent don't output the final RSS (useless on its own, but can be nice when debugging) --silent don't output the final RSS (useless on its own, but
can be nice when debugging)
GNU AGPLv3 code GNU AGPLv3 code
``` ```

View File

@ -44,6 +44,7 @@ def cli_app():
group.add_argument('--proxy', action='store_true', help='doesn\'t fill the articles') group.add_argument('--proxy', action='store_true', help='doesn\'t fill the articles')
group.add_argument('--newest', action='store_true', help='return the feed items in chronological order (morss ohterwise shows the items by appearing order)') group.add_argument('--newest', action='store_true', help='return the feed items in chronological order (morss ohterwise shows the items by appearing order)')
group.add_argument('--firstlink', action='store_true', help='pull the first article mentioned in the description instead of the default link') group.add_argument('--firstlink', action='store_true', help='pull the first article mentioned in the description instead of the default link')
group.add_argument('--resolve', action='store_true', help='replace tracking links with direct links to articles (not compatible with --proxy)')
group = parser.add_argument_group('custom feeds') group = parser.add_argument_group('custom feeds')
group.add_argument('--items', action='store', type=str, metavar='XPATH', help='(mandatory to activate the custom feeds function) xpath rule to match all the RSS entries') group.add_argument('--items', action='store', type=str, metavar='XPATH', help='(mandatory to activate the custom feeds function) xpath rule to match all the RSS entries')

View File

@ -226,6 +226,9 @@ def ItemFill(item, options, feedurl='/', fast=False):
if out is not None: if out is not None:
item.content = out item.content = out
if options.resolve:
item.link = req['url']
return True return True