{ "info": { "author": "Bart Thate", "author_email": "bthate@dds.nl", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "License :: Public Domain", "Operating System :: Unix", "Programming Language :: Python", "Topic :: Utilities" ], "description": "R E A D M E\n###########\n\n| ZELF is a pure python3 framework to program bots, provides an IRC bot to use and is extendible by programming your own commands.\n| ZELF uses a timestamped, type in filename, JSON stringified, files on filesystem backend and has timed based logging capabilities.\n| ZELF has been placed in the Public Domain and contains no copyright or LICENSE.\n\n\nC O D E\n=======\n\n.. autosummary::\n :toctree: code\n :template: module.rst\n\n zelf.all - include all modules.\n zelf.bot\t\t\t - bot base class\n zelf.clock - timers\n zelf.cmds\t\t\t - commands\n zelf.command - command parsing\n zelf.db\t\t\t - db backend\n zelf.errors \t\t - exceptions\n zelf.event\t\t\t - event class\n zelf.fleet - list of bots\n zelf.handler - event handler\n zelf.irc - irc bot\n zelf.kernel\t\t\t - core handler\n zelf.loader - module loader\n zelf.log\t\t\t - logging module\n zelf.obj\t\t\t - object base class.\n zelf.tasks - threads\n zelf.term \t\t\t - terminal handling\n zelf.udp\t\t\t - udp to channel relay\n zelf.user - manage users\n zelf.utils - utilities\n\nI N S T A L L\n=============\n\n\nif you need ZELF to have access to your local directory use this: \n\n> export PYTHONPATH=\".\"\n\nthis will add your current directory to the pythonpath so the packages in it \ncan be found by ZELF.\n\ninstallation is through pypi:\n\n> sudo pip3 install zelf\n\nyou can also run the bot from the tarball at pypi and run it directly or \ninstall with setup.py:\n\n> python3 setup.py install --user\n\n\nrunning from the mercurial repository is also possible:\n\n> hg clone http://bitbucket.org/bthate/zelf\n\nlastely, you can also run directly from the tarball.\n\n\nU S A G E\n=========\n\n\nZELF includes one program, the zelf shell:\n\n> zelf [-m mod1,mod2] command\n \nto connect to irc use the -m zelf.irc option.\n\n> zelf -m zelf.irc -s irc.freenode.net -c \\#zelf -n zelf \n\n\nuse the ed command to edit the last object with a certain type of ZELF objects:\n\n> zelf ed zelf.entry.Log shell=False\n\n\nP R O G R A M M I N G\n=====================\n\n\nprogramming your own commands is easy, your can load modules with the -m option.\nif you create a mods directory and put your hello.py module in it, you would use:\n\n> zelf -m mods\n\nany command you have coded in hello.py would be available, see the `show cmds` command.\n\n> zelf show cmds\n\na command is a function with one argument, the event that was generated on the bot.\n\nexample:\n\n::\n\n def mycmd(event): \n \n\nyou can use event.reply() to send response back to the user:\n\n::\n\n def hello(event): \n event.reply(\"hello %s\" % event.nick)\n\nafter starting zelf with -m mods, you see the hello command added to the bot:\n\n> zelf s cmds\n\ned,find,hello,ps,rm,show,stop,undel\n\n\nH A V E F U N\n===============\n\nenjoy the coding ! ;]\n\n\nBart\n\nbthate@dds.nl | botfather #dunkbots irc.freenode.net | https://pypi.org/project/zelf | http://bitbucket.org/bthate/zelf", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://bitbucket.org/bthate/zelf", "keywords": "", "license": "Public Domain", "maintainer": "", "maintainer_email": "", "name": "zelf", "package_url": "https://pypi.org/project/zelf/", "platform": "", "project_url": "https://pypi.org/project/zelf/", "project_urls": { "Homepage": "https://bitbucket.org/bthate/zelf" }, "release_url": "https://pypi.org/project/zelf/10/", "requires_dist": null, "requires_python": "", "summary": "framework to program bots.", "version": "10" }, "last_serial": 5644539, "releases": { "1": [ { "comment_text": "", "digests": { "md5": "91e14588bcfccff5928d90942c0f56f3", "sha256": "ee33751bac14536ecfad85659ea607a674d4ac21058595b5046392accc8d08ce" }, "downloads": -1, "filename": "zelf-1.tar.gz", "has_sig": false, "md5_digest": "91e14588bcfccff5928d90942c0f56f3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21951, "upload_time": "2019-06-04T12:29:37", "url": "https://files.pythonhosted.org/packages/8e/7f/678a1d7f16509d79fcb13bd17c9610bb79fe59fb0740322c89178087f916/zelf-1.tar.gz" } ], "10": [ { "comment_text": "", "digests": { "md5": "85a02c3f1bd893e10dd5c199774e453b", "sha256": "ca8885f30da97c5ae1d43263b753483dccbb19f94b61a2bd0a53bd752ac5cb94" }, "downloads": -1, "filename": "zelf-10.tar.gz", "has_sig": false, "md5_digest": "85a02c3f1bd893e10dd5c199774e453b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22171, "upload_time": "2019-08-07T11:35:32", "url": "https://files.pythonhosted.org/packages/4c/39/663eee5d40583c408de74d037a58a01cfb71d5a980952950ac90da115dd0/zelf-10.tar.gz" } ], "2": [ { "comment_text": "", "digests": { "md5": "d41a6d35b4c2fdc3477c49ea75365f67", "sha256": "71f3b646c64fae8036c36573e0860ff122208d9908e0419a4bffe199a9f2f7f4" }, "downloads": -1, "filename": "zelf-2.tar.gz", "has_sig": false, "md5_digest": "d41a6d35b4c2fdc3477c49ea75365f67", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21940, "upload_time": "2019-06-05T08:35:28", "url": "https://files.pythonhosted.org/packages/73/e6/413e39fa14828f6e8a6e337c635fe8431dded3473a6ace7ae5bc4e13bfe6/zelf-2.tar.gz" } ], "3": [ { "comment_text": "", "digests": { "md5": "a48384e6413cd5eab210c3ea88cc1077", "sha256": "35d43b83e67ee12d4440d6612ae9da893bd9734fdbb48523e03bb13d945eff0d" }, "downloads": -1, "filename": "zelf-3.tar.gz", "has_sig": false, "md5_digest": "a48384e6413cd5eab210c3ea88cc1077", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18558, "upload_time": "2019-06-07T11:10:48", "url": "https://files.pythonhosted.org/packages/0e/77/c6c1c4d06a4addedd3e515638342f93422671172e83bf5cc763d58b68758/zelf-3.tar.gz" } ], "4": [ { "comment_text": "", "digests": { "md5": "349b87b9fa55325446edf12a3d1835e6", "sha256": "efb3c4c582a3b0daec2ddfa46ac4d771a5acdb8442a9d5705a60a9cf85dd09fa" }, "downloads": -1, "filename": "zelf-4.tar.gz", "has_sig": false, "md5_digest": "349b87b9fa55325446edf12a3d1835e6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18945, "upload_time": "2019-06-11T16:41:45", "url": "https://files.pythonhosted.org/packages/20/b8/01ef0a521949963d059763894a9218ce22dc6bd39a9dada45e646c424aae/zelf-4.tar.gz" } ], "5": [ { "comment_text": "", "digests": { "md5": "e75821204af7bde448f141193f669854", "sha256": "6ba69640102453ef58e30533c0efe0e46e63ec06e9152eea3ed152ae5f112572" }, "downloads": -1, "filename": "zelf-5.tar.gz", "has_sig": false, "md5_digest": "e75821204af7bde448f141193f669854", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20461, "upload_time": "2019-06-14T12:21:26", "url": "https://files.pythonhosted.org/packages/93/e8/33d32f208263340d9192a125d1d6de70e251c62bfa625b86b14614ec21ee/zelf-5.tar.gz" } ], "6": [ { "comment_text": "", "digests": { "md5": "777247c1d757c92c7d48423485029f25", "sha256": "1ee3ec899380d3c07149505b07e000ec3fdcfb45422c821865cc1ff0448c192a" }, "downloads": -1, "filename": "zelf-6.tar.gz", "has_sig": false, "md5_digest": "777247c1d757c92c7d48423485029f25", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21205, "upload_time": "2019-06-19T11:11:25", "url": "https://files.pythonhosted.org/packages/db/6a/f1da82980ed0789baad7061d2354eaefa2f7ff9b8307bb4a75ccc9bd204b/zelf-6.tar.gz" } ], "7": [ { "comment_text": "", "digests": { "md5": "4c7df071ecdb516aa62575776f4c0d1c", "sha256": "0350d8a56cd52c5c45ab9b2cae650f2169623d7c6466735e158be7412cd9ecef" }, "downloads": -1, "filename": "zelf-7.tar.gz", "has_sig": false, "md5_digest": "4c7df071ecdb516aa62575776f4c0d1c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21806, "upload_time": "2019-06-29T13:18:49", "url": "https://files.pythonhosted.org/packages/ef/67/81c59c61088e98dd109e5adee6505b40481daf97262415ba4076899abc8a/zelf-7.tar.gz" } ], "8": [ { "comment_text": "", "digests": { "md5": "e585fefbccf32a34ba40e3f48a08f56d", "sha256": "4ac2c4ebdba6dc7de9584e84a58f1529d826174367f924c7ee94a257b08da6fd" }, "downloads": -1, "filename": "zelf-8.tar.gz", "has_sig": false, "md5_digest": "e585fefbccf32a34ba40e3f48a08f56d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22841, "upload_time": "2019-07-03T19:14:01", "url": "https://files.pythonhosted.org/packages/96/08/4fae9af4eb70757e6bc062353dba1be4aa571aaff90f93dcf3ccc2fc18f7/zelf-8.tar.gz" } ], "9": [ { "comment_text": "", "digests": { "md5": "3660f5eda4626b626326c8be42e4fad5", "sha256": "533cbe0d2770d5c940c286c6a7077081ff7e392ab8a79debf0a73e5de6164d13" }, "downloads": -1, "filename": "zelf-9.tar.gz", "has_sig": false, "md5_digest": "3660f5eda4626b626326c8be42e4fad5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22530, "upload_time": "2019-07-22T12:42:46", "url": "https://files.pythonhosted.org/packages/6e/ef/d9f223554ddcd9f657e41dd5f5671d96b1df9fd14400ff0d2fc750beae91/zelf-9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "85a02c3f1bd893e10dd5c199774e453b", "sha256": "ca8885f30da97c5ae1d43263b753483dccbb19f94b61a2bd0a53bd752ac5cb94" }, "downloads": -1, "filename": "zelf-10.tar.gz", "has_sig": false, "md5_digest": "85a02c3f1bd893e10dd5c199774e453b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22171, "upload_time": "2019-08-07T11:35:32", "url": "https://files.pythonhosted.org/packages/4c/39/663eee5d40583c408de74d037a58a01cfb71d5a980952950ac90da115dd0/zelf-10.tar.gz" } ] }