{
    "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     <your code here>\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.docs",
        "keywords": "",
        "license": "Public Domain",
        "maintainer": "",
        "maintainer_email": "",
        "name": "zelf.docs",
        "package_url": "https://pypi.org/project/zelf.docs/",
        "platform": "",
        "project_url": "https://pypi.org/project/zelf.docs/",
        "project_urls": {
            "Homepage": "https://bitbucket.org/bthate/zelf.docs"
        },
        "release_url": "https://pypi.org/project/zelf.docs/1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "framework to program bots.",
        "version": "1"
    },
    "last_serial": 5644564,
    "releases": {
        "1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d52f1cc69227792441e665e17efbbff9",
                    "sha256": "4b7f5faf4930f9f1f348f97a33f046bad0a128c2d0812b3955cb03d27429df9a"
                },
                "downloads": -1,
                "filename": "zelf.docs-1.tar.gz",
                "has_sig": false,
                "md5_digest": "d52f1cc69227792441e665e17efbbff9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3347,
                "upload_time": "2019-08-07T11:41:27",
                "url": "https://files.pythonhosted.org/packages/2f/16/60f4623b1c1cf95257b9c5ae66873ce04fa9ee244f10678cf05e054576a1/zelf.docs-1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "d52f1cc69227792441e665e17efbbff9",
                "sha256": "4b7f5faf4930f9f1f348f97a33f046bad0a128c2d0812b3955cb03d27429df9a"
            },
            "downloads": -1,
            "filename": "zelf.docs-1.tar.gz",
            "has_sig": false,
            "md5_digest": "d52f1cc69227792441e665e17efbbff9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3347,
            "upload_time": "2019-08-07T11:41:27",
            "url": "https://files.pythonhosted.org/packages/2f/16/60f4623b1c1cf95257b9c5ae66873ce04fa9ee244f10678cf05e054576a1/zelf.docs-1.tar.gz"
        }
    ]
}