Simple cron script to post RSS/ATOM items to Twister
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

74 lines
2.6 KiB

10 years ago
Feed2twister is a simple script to post items from RSS/ATOM feeds to
[Twister](http://twister.net.co).
10 years ago
----
**Note:** If you upgrade an old installation where you don't have
`feed2twister.conf` yet, use a copy of `feed2twister.conf.example`s and
edit it so that it contains similar settings to those you had at `conf.py`
----
10 years ago
### Prerequisites
* Python 2
10 years ago
* [Twister](http://twister.net.co/) (of course)
* [python-bitcoinrpc](https://pypi.python.org/pypi/python-bitcoinrpc/)
* [feedparser](https://pypi.python.org/pypi/feedparser/)
* URL shortener dependencies (see `use_shortener` at `feedparser.conf.example`)
10 years ago
### Installing
10 years ago
* run `git submodule update --init` (to install a [patched
version](https://github.com/thedod/python-bitcoinrpc/tree/unicode-fix-for-twister)
of bitcoin-rpc (a twister-related unicode fix). If you don't have
git(?) you can [download the
zip](https://github.com/thedod/python-bitcoinrpc/archive/unicode-fix-for-twister.zip),
and copy the bitcoinrpc directory into this directory (overwrite
whatever you have ther now. probably an empty folder).
10 years ago
* Copy `feed2twister.conf.example` to `feed2twister.conf` and edit it
to taste.
10 years ago
### Running
10 years ago
Normally, you would run this as a cron task:
`/path/to/this/feed2twister.py [-c CONFIGFILE] [N]`
10 years ago
10 years ago
if [optional] `N` is supplied, it's used as the maximum items to post
(per feed). Default is (by presence order) max_new_items_per_feed from
conf file or 0.
10 years ago
10 years ago
If there are more than `N` new items in a feed, "over quota" items get
marked as if they were posted (this can be handy when you add a new feed
with a long history).
10 years ago
10 years ago
Specifically, `python feed2twister.py 0` would make all feeds "catch up"
without posting anything.
10 years ago
if [optional] `CONFIGFILE` is supplied, it is used as a custom config
file, instead of the first file found in the following list:
`./feed2twister.conf`, `~/.config/feed2twister.conf`,
`~/.feed2twister.conf`
### User defined URL shortener
There is now an option to use your own URL shortener by defining
`use_shortener = user_shortener` at `feed2twister.conf`.
If you're looking for ideas,
the shortener I use is [here](https://github.com/thedod/private_url_shortener#readme).
10 years ago
10 years ago
### Hidden configuration
10 years ago
10 years ago
Some more options are available:
10 years ago
10 years ago
* `do_not_include_link` (boolean, default False): if True, feed2twister
will NOT prepend the feed item title with the item link before posting
it to twister.
10 years ago
10 years ago
* `skip_first_title_char` (int, default None): if set, feed2twister will
strip this amount of character from the begining of the feed item
title. Usefull to skip your login from app.net feed for example.