so you can keep up to date with the latest version, bugfixes and
features:
- https://github.com/wking/rss2email/commits/master.atom
+ http://rss.gmane.org/gmane.mail.rss2email
.. contents::
Packages
--------
-A quick way to get rss2email going is using pre-made packages. Here
-are releases for Debian__ Linux, Ubuntu__ Linux, Gentoo__ Linux, and
-NetBSD__.
+A quick way to get rss2email going is using pre-made packages. There
+are releases for Debian__, Ubuntu__, Fedora__, openSUSE__, Gentoo__,
+and NetBSD__.
__ `Debian package`_
__ `Ubuntu package`_
+__ `Fedora package`_
+__ `openSUSE package`_
__ `Gentoo package`_
__ `NetBSD package`_
1. Ensure that a version of Python_ ≥3.2 is installed.
2. Install the required Python packages.
- 1. feedparser_
- 2. html2text_
+ * feedparser_
+ * html2text_
3. Figure out how you are going to send outgoing email. You have two
options here: either use an STMP server or a local sendmail
program. So,
- * determine your outgoing email server's SMTP address, or
- * install sendmail (or a compatible replacement like postfix).
+ * determine your outgoing email server's SMTP address, or
+ * install sendmail (or a compatible replacement like postfix).
Download
~~~~~~~~
1. A ``.zip`` file (suggested for Microsoft Windows users)::
- $ wget https://github.com/wking/rss2email/archive/v2.71.zip
+ $ wget https://github.com/wking/rss2email/archive/v3.9.zip
$ unzip rss2email-*.zip
2. A ``.tar.gz`` file (suggested for everyone else)::
- $ wget https://github.com/wking/rss2email/archive/v2.71.tar.gz
+ $ wget https://github.com/wking/rss2email/archive/v3.9.tar.gz
$ tar xvf rss2email*.tar.gz
3. A Git_ checkout (suggested for developers)::
- $ git clone git://tremily.us/rss2email.git
+ $ git clone git://github.com/wking/rss2email.git
Install
~~~~~~~
Just repeat the installation procedure for the new source package. If
your config file and data file were in the old source directory, move
them over to the new source directory. If the config and data files
-were in another directory (e.g. ``~/.config/rss2email/``), there is no
-need to move them.
+were in another directory (e.g. ``~/.config`` and ``~/.local/share``),
+there is no need to move them.
Using rss2email
===============
$ r2e new you@yourdomain.com
This command will create a configuration file
-(``~/.config/rss2email/config`` by default) and a feed database
-(``~/.config/rss2email/feeds.dat`` by default). If you'd rather those
+(``$XDG_CONFIG_HOME/rss2email.cfs`` by default) and a feed database
+(``$XDG_DATA_HOME/rss2email.json`` by default). If you'd rather those
files were stored in other locations, use the ``--config`` and
-``--data`` options.
+``--data`` options. ``XDG_CONFIG_HOME`` defaults to ``$HOME/.config``
+and ``XDG_DATA_HOME`` defaults to ``$HOME/.local/share``.
You should edit the default configuration file now to adjust rss2email
for your local system. Unless you've installed a local
Subscribe to some feeds::
- $ r2e add rss2email https://github.com/wking/rss2email/commits/master.atom
+ $ r2e add rss2email http://rss.gmane.org/gmane.mail.rss2email
That's the feed to be notified when there's a new version of
rss2email. Repeat this for each feed you want to subscribe to.
Customizing rss2email
=====================
-There are a number of options, described in full in ``rss2email.py``
-around line 270, to customize the way rss2email behaves. If you want
-to change something, edit the the configuration file that was created
-by ``r2e new``.
+There are a number of options, described in full in
+``rss2email/config.py``, to customize the way rss2email behaves. If
+you want to change something, edit the the configuration file that was
+created by ``r2e new``.
For example, if you want to receive HTML mail, instead of having
entries converted to plain text::
html-mail = True
To be notified every time a post changes, instead of just when it's
-first posted::
+first posted (see also ``trust-link``, described in
+``rss2email/config.py``)::
trust-guid = True
You can make the email address whatever you want, but your mail server
requires that the ``yoursite.com`` part actually exists.
+You can also add custom filters, see the example and documentation in
+``rss2email/post_process/prettify.py`` for more information.
+
SMTP
----
[DEFAULT]
...
use-smtp = True
- smtp-server = smtp.yourisp.net:587
+ smtp-server = smtp.example.net:587
smtp-auth = False
...
23 1 * * * r2e run
+Development
+===========
+
+User discussion and development take place on the rss2email mailing
+list at ``rss2email@tremily.us``. Everyone is welcome to post bug
+reports, feature requests, comments, and patches. To subscribe to the
+list, send an email to ``rss2email+subscribe@tremily.us``. The
+mailing list archives are available on Gmane_.
+
.. _Debian package:
- http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&version=all&exact=1&keywords=rss2email
+ http://packages.qa.debian.org/r/rss2email.html
.. _Ubuntu package:
- http://packages.ubuntu.com/search?keywords=rss2email&searchon=names§ion=all
+ https://launchpad.net/ubuntu/+source/rss2email
+.. _Fedora package:
+ https://admin.fedoraproject.org/pkgdb/acls/name/rss2email
+.. _openSUSE package:
+ https://build.opensuse.org/package/show?package=rss2email&project=server%3Amail
.. _NetBSD package:
- ftp://ftp.netbsd.org/pub/NetBSD/NetBSD-current/pkgsrc/mail/rss2email/README.html
+ http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/mail/rss2email/README.html
.. _Gentoo package:
http://gpo.zugaina.org/net-mail/rss2email
.. _Python: http://www.python.org
.. _STARTTLS: http://en.wikipedia.org/wiki/STARTTLS
.. _windows scheduler: http://www.iopus.com/guides/winscheduler.htm
.. _cron: http://en.wikipedia.org/wiki/Cron
+.. _Gmane: http://dir.gmane.org/gmane.mail.rss2email
projects / rss2email.git / blobdiff