Metadata-Version: 2.1
Name: rssbot
Version: 570
Summary: 24/7 feed fetcher
Author-email: Bart Thate <bthate@dds.nl>
License: Public Domain
Project-URL: home, https://pypi.org/project/rssbot
Project-URL: bugs, https://github.com/xobjectz/rssbot/issues
Project-URL: source, https://github.com/xobjectz/rssbot
Classifier: Development Status :: 3 - Alpha
Classifier: License :: Public Domain
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Topic :: Utilities
Description-Content-Type: text/x-rst

NAME

::

    RSSBOT - 24/7 feed Fetcher

INSTALL

::

    $ pipx install rssbot
    $ pipx ensurepath


SYNOPSIS

::

    rssbot <cmd> [key=val] [key==val]
    rssbotd


DESCRIPTION

::

    RSSBOT is a python3 bot able to display rss feeds in your channel.

    RSSBOT comes with a cli to configure and a daemon to run in the
    background, hooking the daemon in systemd brings a 24/7 available
    rssbot in your channel.


COMMANDS

::

    cfg - irc configuration
    cmd - commands
    dpl - sets display items
    exp - export opml (stdout)
    imp - import opml
    mre - displays cached output
    pwd - sasl nickserv name/pass
    rem - removes a rss feed
    res - restore deleted objects
    rss - add a feed
    syn - sync rss feeds


CONFIGURATION

::

    irc

    $ rssbot cfg server=<server>
    $ rssbot cfg channel=<channel>
    $ rssbot cfg nick=<nick>

    sasl
 
    $ rssbot pwd <nsvnick> <nspass>
    $ rssbot cfg password=<frompwd>

    rss

    $ rssbot rss <url>
    $ rssbot dpl <url> <item1,item2>
    $ rssbot rem <url>
    $ rssbot nme <url> <name>

    opml

    $ rssbot exp
    $ rssbot imp <filename>


SYSTEMD

::

    save the following it in /etc/systemd/system/rssbot.service and
    replace "<user>" with the user running pipx


    [Unit]
    Description=24/7 feed fetcher
    Requires=network-online.target
    After=network-online.target

    [Service]
    Type=simple
    User=<user>
    Group=<user>
    WorkingDirectory=/home/<user>/.rssbot
    ExecStart=/home/<user>/.local/pipx/venvs/rssbot/bin/rssbotd
    PIDFile=/home/<user>/.rssbot/rssbot.pid
    RemainAfterExit=yes

    [Install]
    WantedBy=default.target

    then run this

    $ mkdir ~/.rssbot
    $ sudo systemctl enable rssbot --now

    default channel/server is #rssbot on localhost


FILES

::

    ~/.rssbot
    ~/.local/bin/rssbot
    ~/.local/bin/rssbotd
    ~/.local/pipx/venvs/rssbot/


AUTHOR

::

    Bart Thate <bthate@dds.nl>


COPYRIGHT

::

    RSSBOT is Public Domain.
