libbot 56__tar.gz → 70__tar.gz

libbot-70/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.1
+Name: libbot
+Version: 70
+Summary: the python3 bot namespace
+Author-email: libbot <libbotx@gmail.com>
+License: Public Domain
+Project-URL: home, https://pypi.org/project/libbot
+Project-URL: bugs, https://github.com/botlibx/libbot/issues
+Project-URL: source, https://github.com/botlibx/libbot
+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
+
+::
+
+    LIBBOT - the python3 bot namespave
+
+SYNOPSIS
+
+::
+
+    bot <cmd> [key=val] 
+    bot <cmd> [key==val]
+    bot [-c] [-v] [-d]
+
+
+DESCRIPTION
+
+::
+
+
+
+    LIBBOT is a python3 library implementing the 'bot' package. It
+    provides all the tools to program a bot, such as disk perisistence
+    for configuration files, event handler to handle the client/server
+    connection, code to introspect modules for commands, deferred
+    exception handling to not crash on an error, a parser to parse
+    commandline options and values, etc.
+
+    LIBBOT provides a demo bot, it can connect to IRC, fetch and
+    display RSS feeds, take todo notes, keep a shopping list
+    and log text. You can also copy/paste the service file and run
+    it under systemd for 24/7 presence in a IRC channel.
+
+    LIBBOT is a contribution back to society and is Public Domain.
+
+
+INSTALL
+
+
+::
+
+    $ pipx install libbot
+
+
+USAGE
+
+::
+
+    without any argument the bot does nothing
+
+    $ bot
+    $
+
+    see list of commands
+
+    $ bot cmd
+    cmd,err,mod,req,thr,ver
+
+    list of modules
+
+    $ bot mod
+    cmd,err,fnd,irc,log,mod,req,rss,tdo,thr
+
+    use mod=<name1,name2> to load additional
+    modules
+
+    $ bot cfg mod=irc
+
+    start a console
+
+    $ bot -c mod=irc,rss
+    >
+
+    use -v for verbose
+
+    $ bot -cv mod=irc
+    BOT started CV started Sat Dec 2 17:53:24 2023
+    >
+
+    start daemon
+
+    $ botd
+    $ 
+
+
+CONFIGURATION
+
+
+::
+
+    irc
+
+    $ bot cfg server=<server>
+    $ bot cfg channel=<channel>
+    $ bot cfg nick=<nick>
+
+    sasl
+
+    $ bot pwd <nsvnick> <nspass>
+    $ bot cfg password=<frompwd>
+
+     rss
+
+    $ bot rss <url>
+    $ bot dpl <url> <item1,item2>
+    $ bot rem <url>
+    $ bot nme <url< <name>
+
+
+COMMANDS
+
+
+::
+
+    cmd - commands
+    cfg - irc configuration
+    dlt - remove a user
+    dpl - sets display items
+    fnd - find objects 
+    log - log some text
+    met - add a user
+    mre - displays cached output
+    pwd - sasl nickserv name/pass
+    rem - removes a rss feed
+    req - reconsider
+    rss - add a feed
+    thr - show the running threads
+
+
+SYSTEMD
+
+
+::
+
+    replace "<user>" with the user running pipx
+
+
+    [Unit]
+    Description=24/7 channel daemon
+    Requires=network.target
+    After=network.target
+
+    [Service]
+    Type=simple
+    User=<user>
+    Group=<user>
+    WorkingDirectory=/home/<user>/.bot
+    ExecStart=/home/<user>/.local/pipx/venvs/libbot/bin/botd
+    RemainAfterExit=yes
+
+    [Install]
+    WantedBy=multi-user.target
+
+
+    then run this
+
+    $ mkdir ~/.bot
+    $ sudo systemctl enable botd --now
+
+    default channel/server is #bot on localhost
+
+
+FILES
+
+::
+
+    ~/.bot
+    ~/.local/bin/bot
+    ~/.local/bin/botd
+    ~/.local/pipx/venvs/libbot/
+
+
+AUTHOR
+
+
+::
+
+    libbotx <libbotx@gmail.com>
+
+
+COPYRIGHT
+
+
+::
+
+    LIBBOT is Public Domain.

libbot-70/README.rst

@@ -0,0 +1,186 @@
+NAME
+
+::
+
+    LIBBOT - the python3 bot namespave
+
+SYNOPSIS
+
+::
+
+    bot <cmd> [key=val] 
+    bot <cmd> [key==val]
+    bot [-c] [-v] [-d]
+
+
+DESCRIPTION
+
+::
+
+
+
+    LIBBOT is a python3 library implementing the 'bot' package. It
+    provides all the tools to program a bot, such as disk perisistence
+    for configuration files, event handler to handle the client/server
+    connection, code to introspect modules for commands, deferred
+    exception handling to not crash on an error, a parser to parse
+    commandline options and values, etc.
+
+    LIBBOT provides a demo bot, it can connect to IRC, fetch and
+    display RSS feeds, take todo notes, keep a shopping list
+    and log text. You can also copy/paste the service file and run
+    it under systemd for 24/7 presence in a IRC channel.
+
+    LIBBOT is a contribution back to society and is Public Domain.
+
+
+INSTALL
+
+
+::
+
+    $ pipx install libbot
+
+
+USAGE
+
+::
+
+    without any argument the bot does nothing
+
+    $ bot
+    $
+
+    see list of commands
+
+    $ bot cmd
+    cmd,err,mod,req,thr,ver
+
+    list of modules
+
+    $ bot mod
+    cmd,err,fnd,irc,log,mod,req,rss,tdo,thr
+
+    use mod=<name1,name2> to load additional
+    modules
+
+    $ bot cfg mod=irc
+
+    start a console
+
+    $ bot -c mod=irc,rss
+    >
+
+    use -v for verbose
+
+    $ bot -cv mod=irc
+    BOT started CV started Sat Dec 2 17:53:24 2023
+    >
+
+    start daemon
+
+    $ botd
+    $ 
+
+
+CONFIGURATION
+
+
+::
+
+    irc
+
+    $ bot cfg server=<server>
+    $ bot cfg channel=<channel>
+    $ bot cfg nick=<nick>
+
+    sasl
+
+    $ bot pwd <nsvnick> <nspass>
+    $ bot cfg password=<frompwd>
+
+     rss
+
+    $ bot rss <url>
+    $ bot dpl <url> <item1,item2>
+    $ bot rem <url>
+    $ bot nme <url< <name>
+
+
+COMMANDS
+
+
+::
+
+    cmd - commands
+    cfg - irc configuration
+    dlt - remove a user
+    dpl - sets display items
+    fnd - find objects 
+    log - log some text
+    met - add a user
+    mre - displays cached output
+    pwd - sasl nickserv name/pass
+    rem - removes a rss feed
+    req - reconsider
+    rss - add a feed
+    thr - show the running threads
+
+
+SYSTEMD
+
+
+::
+
+    replace "<user>" with the user running pipx
+
+
+    [Unit]
+    Description=24/7 channel daemon
+    Requires=network.target
+    After=network.target
+
+    [Service]
+    Type=simple
+    User=<user>
+    Group=<user>
+    WorkingDirectory=/home/<user>/.bot
+    ExecStart=/home/<user>/.local/pipx/venvs/libbot/bin/botd
+    RemainAfterExit=yes
+
+    [Install]
+    WantedBy=multi-user.target
+
+
+    then run this
+
+    $ mkdir ~/.bot
+    $ sudo systemctl enable botd --now
+
+    default channel/server is #bot on localhost
+
+
+FILES
+
+::
+
+    ~/.bot
+    ~/.local/bin/bot
+    ~/.local/bin/botd
+    ~/.local/pipx/venvs/libbot/
+
+
+AUTHOR
+
+
+::
+
+    libbotx <libbotx@gmail.com>
+
+
+COPYRIGHT
+
+
+::
+
+    LIBBOT is Public Domain.

libbot-70/bin/bot

@@ -0,0 +1,106 @@
+#!/usr/bin/env python3
+# This file is placed in the Public Domain.
+#
+# pylint: disable=C,R,W0201,W0212,W0105,W0613,W0406,E0102,W0611,W0718,W0125
+
+
+"runtime"
+
+
+import getpass
+import os
+import sys
+import termios
+import time
+
+
+sys.path.insert(0, os.getcwd())
+
+
+from obj import Default, Object
+from prg import Client, Error, Event, Storage
+from prg import cmnd, debug, forever, parse_command, scan, spl
+from bot import modules
+
+
+Cfg         = Default()
+Cfg.mod     = "cmd,err,irc,mod,mre,pwd,rss,thr"
+Cfg.name    = "bot"
+Cfg.version = "70"
+Cfg.wd      = os.path.expanduser(f"~/.{Cfg.name}")
+Cfg.pidfile = os.path.join(Cfg.wd, f"{Cfg.name}.pid")
+Cfg.user    = getpass.getuser()
+
+
+Storage.wd   = Cfg.wd
+
+
+class Console(Client):
+
+    def announce(self, txt):
+        if "v" in Cfg.opts:
+            self.say("", txt)
+
+    def poll(self) -> Event:
+        evt = Event()
+        evt.orig = object.__repr__(self)
+        evt.txt = input("> ")
+        evt.type = "command"
+        return evt
+
+    def say(self, channel, txt):
+        txt = txt.encode('utf-8', 'replace').decode()
+        print(txt)
+
+
+def wrap(func) -> None:
+    old2 = None
+    try:
+        old2 = termios.tcgetattr(sys.stdin.fileno())
+    except termios.error:
+        pass
+    try:
+        func()
+    except (KeyboardInterrupt, EOFError):
+        print("")
+    finally:
+        if old2:
+            termios.tcsetattr(sys.stdin.fileno(), termios.TCSADRAIN, old2)
+
+
+"runtime"
+
+
+if os.path.exists("mods"):
+    import mods
+else:
+    mods = None
+
+
+def main():
+    Storage.skel()
+    parse_command(Cfg, " ".join(sys.argv[1:]))
+    if "a" in Cfg.opts:
+        Cfg.mod = ",".join(modules.__dir__())
+        if "m" in Cfg.opts:
+            Cfg.mod += "," +  ",".join(mods.__dir__())
+    if "v" in Cfg.opts:
+        dte = time.ctime(time.time()).replace("  ", " ")
+        debug(f"{Cfg.name.upper()} started {Cfg.opts.upper()} started {dte}")
+    csl = Console()
+    if "c" in Cfg.opts:
+        scan(modules, Cfg.mod, True, True)
+        if "m" in Cfg.opts:
+            scan(mods, Cfg.mod, True, True)
+        csl.start()
+        forever()
+    if Cfg.otxt:
+        scan(modules, Cfg.mod)
+        if "m" in Cfg.opts:
+            scan(mods, Cfg.mod)
+        return cmnd(Cfg.otxt)
+
+
+if __name__ == "__main__":
+    wrap(main)
+    Error.show()

libbot-70/bin/botd

@@ -0,0 +1,90 @@
+#!/usr/bin/env python3
+# This file is placed in the Public Domain.
+#
+# pylint: disable=C,R,W0201,W0212,W0105,W0613,W0406,E0102,W0611,W0718,W0125
+
+
+"runtime"
+
+
+import getpass
+import os
+import pwd
+import sys
+import termios
+import time
+
+
+sys.path.insert(0, os.getcwd())
+
+
+from obj import Default, Object
+from prg import Client, Error, Event, Storage
+from prg import cmnd, debug, forever, parse_command, scan, spl
+from bot import modules
+
+
+from prg.storage import cdir
+
+
+Cfg         = Default()
+Cfg.mod     = "cmd,err,irc,log,mod,mre,pwd,rss,thr"
+Cfg.name    = "bot"
+Cfg.version = "70"
+Cfg.wd      = os.path.expanduser(f"~/.{Cfg.name}")
+Cfg.pidfile = os.path.join(Cfg.wd, f"{Cfg.name}.pid")
+Cfg.user    = getpass.getuser()
+
+
+Storage.wd  = Cfg.wd
+moddir      = os.path.join(Storage.wd, "mods")
+
+
+if os.path.exists(moddir):
+    sys.path.insert(0, os.path.dirname(moddir))
+    import mods
+else:
+    mods = None
+
+
+def daemon(pidfile, verbose=False):
+    pid = os.fork()
+    if pid != 0:
+        os._exit(0)
+    os.setsid()
+    pid2 = os.fork()
+    if pid2 != 0:
+        os._exit(0)
+    if not verbose:
+        with open('/dev/null', 'r', encoding="utf-8") as sis:
+            os.dup2(sis.fileno(), sys.stdin.fileno())
+        with open('/dev/null', 'a+', encoding="utf-8") as sos:
+            os.dup2(sos.fileno(), sys.stdout.fileno())
+        with open('/dev/null', 'a+', encoding="utf-8") as ses:
+            os.dup2(ses.fileno(), sys.stderr.fileno())
+    os.umask(0)
+    os.chdir("/")
+    if os.path.exists(pidfile):
+        os.unlink(pidfile)
+    cdir(os.path.dirname(pidfile))
+    with open(pidfile, "w", encoding="utf-8") as fds:
+        fds.write(str(os.getpid()))
+
+
+def privileges(username):
+    pwnam = pwd.getpwnam(username)
+    os.setgid(pwnam.pw_gid)
+    os.setuid(pwnam.pw_uid)
+
+
+def main():
+    Storage.skel()
+    daemon(Cfg.pidfile)
+    privileges(Cfg.user)
+    scan(modules, Cfg.mod, True, True)
+    if mods:
+        scan(mods, Cfg.mod, True, True)
+    forever()
+
+
+main()

libbot-70/bot/modules/__init__.py

@@ -0,0 +1,31 @@
+# This file is placed in the Public Domain.
+#
+#
+
+
+"pre-import"
+
+
+import sys
+
+
+from . import cmd, err, irc, log, mod, mre, pwd, rss, tdo, thr, tmr
+
+
+def __dir__():
+    return (
+        'cmd',
+        'err',
+        'irc',
+        'log',
+        'mod',
+        'mre',
+        'pwd',
+        'rss',
+        'tdo',
+        'thr',
+        'tmr',
+    )
+
+
+__all__ = __dir__()

{libbot-56 → libbot-70}/bot/modules/cmd.py

@@ -6,8 +6,8 @@
 "list of commands"
 
 
-from .. import Commands
+from prg import Command
 
 
 def cmd(event):
-    event.reply(",".join(sorted(Commands.cmds)))
+    event.reply(",".join(sorted(Command.cmds)))

libbot-70/bot/modules/err.py

@@ -0,0 +1,22 @@
+# This file is placed in the Public Domain.
+#
+# pylint: disable=C0116,W0105,E0402,E0611
+
+
+"status of bots"
+
+
+from prg import Error, Fleet
+
+
+def err(event):
+    nmr = 0
+    for bot in Fleet.objs:
+        if 'state' in dir(bot):
+            event.reply(str(bot.state))
+            nmr += 1
+    event.reply(f"status: {nmr} errors: {len(Error.errors)}")
+    for exc in Error.errors:
+        txt = Error.format(exc)
+        for line in txt.split():
+            event.reply(line)