{ "info": { "author": "Bart Thate", "author_email": "bthate67@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "License :: Public Domain", "Operating System :: Unix", "Programming Language :: Python", "Topic :: Utilities" ], "description": "README\n######\n\nWelcome to OBOT,\n\nOBOT is a pure python3 IRC bot you can use to display RSS feeds, act as a \nUDP to IRC relay and one you can program your own commands for. \n\nOBOT is placed in the Public Domain and has no COPYRIGHT and no LICENSE.\n\nINSTALL\n=======\n\nOBOT can be found on pypi, see http://pypi.org/project/obot\n\ninstallation is through pypi::\n\n $ sudo pip3 install obot --upgrade --force-reinstall\n\nCONFIGURE\n=========\n\nOBOT has it's own CLI, the bot program, you can run it on the shell prompt \nand, as default, it won't do anything::\n\n $ obot\n $ \n\nuse obot to run a command directly, e.g. the cmd command shows\na list of commands::\n\n $ obot cmd\n cfg,cmd,dlt,dne,dpl,flt,fnd,ftc,krn,log,met,mod,rem,rss,thr,ver,upt\n\nconfiguration is done with the cfg command::\n\n $ obot cfg server=irc.freenode.net channel=\\#dunkbots nick=botje\n ok\n\nstart the bot with the irc module enabled::\n\n $ obot mods=irc\n >\n\na shell is started as well so you can type commands on the bot's console.\n\nRSS\n===\n\nOBOT provides, with the use of feedparser, the possibility to serve rss\nfeeds in your channel. Install python3-feedparser if you want to display \nrss feeds in the channel::\n\n $ sudo apt install python3-feedparser\n\nTo add an url use the rss command with an url::\n\n $ obot rss https://github.com/bthate/botlib/commits/master.atom\n ok\n\nrun the fnd (find) command to see what urls are registered::\n\n $ obot fnd rss\n 0 https://github.com/bthate/botlib/commits/master.atom\n\nthe ftc (fetch) command can be used to poll the added feeds::\n\n $ obot ftc\n fetched 20\n\nUDP\n===\n\nOBOT has the possibility to serve as a UDP to IRC relay where you\ncan send UDP packages to the bot and have txt displayed in the channel.\n\nto enable udp start the bot with the udp module enabled::\n\n $ obot mods=irc,udp\n\noutput to the IRC channel is done with the use python3 code to send a UDP\npacket to OBOT, it's unencrypted txt send to the bot and displayed in the\njoined channels:\n\n import socket\n\n def toudp(host=localhost, port=5500, txt=\"\"):\n sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)\n sock.sendto(bytes(txt.strip(), \"utf-8\"), host, port)\n\n\nCOMMANDS\n========\n\nIf you want to program on the bot and write your own commands, clone the\nrepository at github::\n\n $ sudo git clone https://github.com/bthate67/obot\n\nprogramming your own commands is easy, open mod/hlo.py and add the following\ncode::\n\n def hlo(event):\n event.reply(\"hello %s\" % event.origin)\n\nrecreate the dispatch table by using the tbl command::\n\n $ bin/tbl > obot/tbl.py\n\nnow you can type the \"hlo\" command, showing hello ::\n\n $ obot hlo\n hello root@console\n\n24/7\n====\n\nto run OBOT 24/7 you need to enable the bots service under systemd:\n\nedit /etc/systemd/system/bot.service and add the following txt::\n\n [Unit]\n Description=OBOTD - 24/7 channel service\n After=multi-user.target\n\n [Service]\n DynamicUser=True\n StateDirectory=obotd\n LogsDirectory=obotd\n CacheDirectory=obotd\n ExecStart=/usr/local/bin/obotd\n CapabilityBoundingSet=CAP_NET_RAW\n\n [Install]\n WantedBy=multi-user.target\n\nthen enable the bot service with::\n\n $ sudo systemctl enable obotd\n $ sudo systemctl daemon-reload\n\nedit the irc configuration::\n\n $ sudo obotd cfg server=irc.freenode.net channel=\\#dunkbots \n\nand start the bot::\n\n $ sudo systemctl start obotd\n\nif you don't want the bot to startup at boot, remove the service file::\n\n $ sudo rm /etc/systemd/system/obotd.service\n\nCONTACT\n=======\n\nhave fun coding\n\n| Bart Thate (bthate67@gmail.com)\n| botfather on #dunkbots irc.freenode.net", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/bthate67/botlib", "keywords": "", "license": "Public Domain", "maintainer": "", "maintainer_email": "", "name": "obot", "package_url": "https://pypi.org/project/obot/", "platform": "", "project_url": "https://pypi.org/project/obot/", "project_urls": { "Homepage": "https://github.com/bthate67/botlib" }, "release_url": "https://pypi.org/project/obot/100/", "requires_dist": null, "requires_python": "", "summary": "python3 bot library", "version": "100", "yanked": false, "yanked_reason": null }, "last_serial": 10160614, "releases": { "100": [ { "comment_text": "", "digests": { "md5": "854466d40d41048336b0aa99160a785d", "sha256": "639403d30005f406ee2e0f1a903d0e1843c5a7d5a545adaf9fa5a3e364388e99" }, "downloads": -1, "filename": "obot-100.tar.gz", "has_sig": false, "md5_digest": "854466d40d41048336b0aa99160a785d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 25671, "upload_time": "2021-04-24T17:07:22", "upload_time_iso_8601": "2021-04-24T17:07:22.780640Z", "url": "https://files.pythonhosted.org/packages/3f/ef/d80a2606cf219d0b081bd27c8596235c769631adf4570b2b5418a68921b5/obot-100.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "854466d40d41048336b0aa99160a785d", "sha256": "639403d30005f406ee2e0f1a903d0e1843c5a7d5a545adaf9fa5a3e364388e99" }, "downloads": -1, "filename": "obot-100.tar.gz", "has_sig": false, "md5_digest": "854466d40d41048336b0aa99160a785d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 25671, "upload_time": "2021-04-24T17:07:22", "upload_time_iso_8601": "2021-04-24T17:07:22.780640Z", "url": "https://files.pythonhosted.org/packages/3f/ef/d80a2606cf219d0b081bd27c8596235c769631adf4570b2b5418a68921b5/obot-100.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }