{ "info": { "author": "Lighthouse Team", "author_email": "engineering@opengear.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: System Administrators", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3" ], "description": "Lighthouse API client\n=====================\n\nThis project provides a ready to go implementation of the `Lighthouse\nAPI Client `__ as a Slack Bot.\n\nIt has also a `Docker\nimage `__ for launching\nthe slack bot in minutes.\n\nAuthentication\n--------------\n\nThe **Lighthouse API Client** expects to find the following environment\nvariables:\n\n- **(required)** ``OGLH_API_USER`` a valid Lighthouse user\n- **(required)** ``OGLH_API_PASS`` a valid Lighthouse user's password\n- **(required)** ``OGLH_API_URL`` the Lighthouse API url without\n ``/api/v1``\n\nLighthouse Slack Bot\n--------------------\n\nIt expects to find the following environment variables:\n\n- **(required)** ``SLACK_BOT_TOKEN`` which is provided by Slack at the\n moment of `creating a bot `__.\n- **(required)** ``SLACK_BOT_NAME`` is the name given to the Slack bot.\n- **(required)** ``SLACK_BOT_DEFAULT_CHANNEL`` a default Slack channel\n name used for warnings.\n- **(optional)** ``SLACK_BOT_DEFAULT_LOG_CHANNEL`` a Slack channel name\n for logs, if it is not provided, logs will be printed to a file only,\n but logs classified as high priority like warnings and errors will be\n printed to the ``SLACK_BOT_DEFAULT_CHANNEL`` when\n ``SLACK_BOT_DEFAULT_LOG_CHANNEL`` is not set.\n- **(optional)** ``SLACK_BOT_ADMIN_CHANNEL`` is the name for the\n administrator channel, if no name is informed, it is assumed to be\n **oglhadmin**.\n\nThe **Lighhouse** Slack bot can be triggered as simple as:\n\n.. code:: python\n\n >>> from oglhslack import OgLhSlackBot\n >>> slack_bot = OgLhSlackBot()\n >>> slack_bot.listen()\n\nOr, straight from the terminal:\n\n.. code:: bash\n\n $ python oglhslack.py\n\nCommands\n--------\n\nIt is possible to interact with the Slack Bot in private messages (PM),\nprivate or public channels. When commands are not performed in private\nmessages, they must be prefixed by ``@mybot``, where ``mybot`` is the\nbot's name.\n\nBuilt in commands\n~~~~~~~~~~~~~~~~~\n\nThere is a small set of commands which can be found the bot's help, they\nare pretty straight in what they do. It is possible this list of\ncommands through:\n\n::\n\n @mybot help\n\nSome commands have **(admin only)** on theirs descriptions, indicating\nthat they can be performed in the ``oglhadmin`` channel.\n\nAPI client commands\n~~~~~~~~~~~~~~~~~~~\n\nThis commands follow the `Lighthouse API\nClient `__ conventions.\n\nFor listing objects like ``nodes`` it is possible to perform:\n\n::\n\n @mybot list nodes\n\nFor listing tags belonging to a node with id *my-node-name*:\n\n::\n\n @mybot list tags from node my-node-name\n\nFor listing smartgroups:\n\n::\n\n @mybot list smartgroups from nodes\n\nFor getting information regarding to a specific node:\n\n::\n\n @mybot find node my-node-name\n\nFor getting systems's information:\n\n::\n\n @mybot get hostname from system\n\nIt works basically as:\n\nListing objects of a given type, like **nodes**, **ports**, and so on. >\n**list** *objects*\n\nListing objects of a given type, belonging to a parent object, like\n**system**. > **list** *objects* **from** *parent-object*\n\nListing objects of a given type, belonging to a parent object specified\nby its id. > **list** *objects* **from** *parent-object* *parent-name*\n\nFind specific objects by their ids. > **find** *object* *object-name*\n\nFind specific objects by their ids, when belonging to parent objects. >\n**find** *object* *object-name* **from** *parent-object*\n\n **find** *object* *object-name* **from** *parent-object*\n *parent-name*\n\nGet objects when **list** and **find** do not apply > **get** *object*\n**from** *parent-object*\n\nChannels conventions\n--------------------\n\nAdministration channel\n~~~~~~~~~~~~~~~~~~~~~~\n\nCommands that make changes in Lighthouse are not allowed in normal\nchannels or in private messages.\n\nIn order to execute such commands, it is required that the Slack\nadministrator creates a channel named **oglhadmin**, or with the name\nspecified in the ``SLACK_BOT_ADMIN_CHANNEL`` environment variable. This\nchannel is supposed to be open for authorized members only.\n\nDocker image\n------------\n\nThe Opengear Lighthouse docker image is available at\nhttps://hub.docker.com/r/opengeardev/oglhslack/.\n\nIt requires a file containing the environment variables as specified\n`here `__.\n\nIt is supposed to be like:\n\n::\n\n SLACK_BOT_TOKEN=xoxb-************-************************\n SLACK_BOT_NAME=mybotname\n SLACK_BOT_DEFAULT_CHANNEL=myDefaultChannel\n SLACK_BOT_DEFAULT_LOG_CHANNEL=myDefaultLogChannel\n SLACK_BOT_ADMIN_CHANNEL=oglhadmin\n OGLH_API_USER=myOgLhUser\n OGLH_API_PASS=myOgLhPassword\n OGLH_API_URL=https://oglh-octo.opengear.com\n\nFor launching the Slack bot just run:\n\n.. code:: bash\n\n $ sudo docker run --env-file /path/to/my/env.list opengeardev/oglhslack", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/opengear/oglhslack/archive/v1.0.0.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/opengear/oglhslack", "keywords": "api,opengear,lighthouse,slackbot", "license": "", "maintainer": "", "maintainer_email": "", "name": "oglhslack", "package_url": "https://pypi.org/project/oglhslack/", "platform": "", "project_url": "https://pypi.org/project/oglhslack/", "project_urls": { "Download": "https://github.com/opengear/oglhslack/archive/v1.0.0.tar.gz", "Homepage": "https://github.com/opengear/oglhslack" }, "release_url": "https://pypi.org/project/oglhslack/1.0.0/", "requires_dist": null, "requires_python": "", "summary": "A Slack chat bot for Opengear Lighthouse", "version": "1.0.0" }, "last_serial": 3239355, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "62a6ce20a985593e6e472619e8fee763", "sha256": "63878859a8fbaaf4b1b495bef77229f9a3dc161a09d8981adcc68d208c306593" }, "downloads": -1, "filename": "oglhslack-0.1.0.tar.gz", "has_sig": false, "md5_digest": "62a6ce20a985593e6e472619e8fee763", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 424, "upload_time": "2017-08-08T02:01:10", "url": "https://files.pythonhosted.org/packages/0d/9d/d6b843944587fe093fa3da17d4a86596299b7a62d1bfbbb8ca1dbde39095/oglhslack-0.1.0.tar.gz" } ], "0.1.0.0": [ { "comment_text": "", "digests": { "md5": "9c9ed390b7cc07c0aae4546a116338f0", "sha256": "93114d8f903b230475eab9c24a57b3bde520ab713ba266eafb4d7e006558dfeb" }, "downloads": -1, "filename": "oglhslack-0.1.0.0.tar.gz", "has_sig": false, "md5_digest": "9c9ed390b7cc07c0aae4546a116338f0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 425, "upload_time": "2017-08-08T02:04:23", "url": "https://files.pythonhosted.org/packages/5e/95/1be6e22d57d320e5b6d10cdcb5b0e3f7f47346eb5f8d584fb2c32c416843/oglhslack-0.1.0.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "7a288d8d4a5fee0e1dd5ba3bea2503e5", "sha256": "8814d2d1b3dd4bc1e5fa99906c28828436ead81e71e4d9a7af572d4b850f0903" }, "downloads": -1, "filename": "oglhslack-0.1.1.tar.gz", "has_sig": false, "md5_digest": "7a288d8d4a5fee0e1dd5ba3bea2503e5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 417, "upload_time": "2017-08-08T02:18:54", "url": "https://files.pythonhosted.org/packages/77/d3/a02994896e1c4e79822d862fed2f166800b75ac52fd3dfc644e6bfc181ee/oglhslack-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "8e40f69a6907eb846880e8a3f77f73f3", "sha256": "0773424c0f08f25c360102e9d435baab65fb7d2b2660db9eca12e0b19b9bb93b" }, "downloads": -1, "filename": "oglhslack-0.1.2.tar.gz", "has_sig": false, "md5_digest": "8e40f69a6907eb846880e8a3f77f73f3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5652, "upload_time": "2017-08-08T02:21:44", "url": "https://files.pythonhosted.org/packages/b9/6e/e08ec0bee037de6e8986dcd2ad3b3aed58997d46cd31b99def0a1747e948/oglhslack-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "3f0fa0824aff09e43dec9343a91206d5", "sha256": "63a66882198cf89326101fd2651815f7d804134d0da63ff0b3af96a92b232301" }, "downloads": -1, "filename": "oglhslack-0.1.3.tar.gz", "has_sig": false, "md5_digest": "3f0fa0824aff09e43dec9343a91206d5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6242, "upload_time": "2017-08-10T13:18:30", "url": "https://files.pythonhosted.org/packages/d7/a6/5cd547f195bff2e1a17a11d738c2dd56d76a9c42793b8f5ea32ff016bc13/oglhslack-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "9823db97536fad4560c2259735c12372", "sha256": "e9661de4009e39fe059daa41fbbbb6a0bb95887d86861f04165f3ae4a3d287b1" }, "downloads": -1, "filename": "oglhslack-0.1.4.tar.gz", "has_sig": false, "md5_digest": "9823db97536fad4560c2259735c12372", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7394, "upload_time": "2017-08-11T04:14:05", "url": "https://files.pythonhosted.org/packages/eb/0b/004f0f1e2485522056dd29f53672bd51a148eef5c0b773ec42f3a3409fb0/oglhslack-0.1.4.tar.gz" } ], "0.1.4.1": [ { "comment_text": "", "digests": { "md5": "d3f0c82054415239d9f19242af9feec4", "sha256": "a814793641ed11633ab1ed6c28dcedd45868bc5be93e62580d220319b978cfb3" }, "downloads": -1, "filename": "oglhslack-0.1.4.1.tar.gz", "has_sig": false, "md5_digest": "d3f0c82054415239d9f19242af9feec4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8747, "upload_time": "2017-08-14T03:30:49", "url": "https://files.pythonhosted.org/packages/95/0c/564efdd10ebacedd5f97087f8715213205ded115a4c36c49e139a5df920d/oglhslack-0.1.4.1.tar.gz" } ], "0.1.4.2": [ { "comment_text": "", "digests": { "md5": "d907cbec08097e28ea034af24f89e104", "sha256": "f179521472d44ae6a7618f6a69fc9af3439bd7951c91f067c19516160fccc2ee" }, "downloads": -1, "filename": "oglhslack-0.1.4.2.tar.gz", "has_sig": false, "md5_digest": "d907cbec08097e28ea034af24f89e104", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9699, "upload_time": "2017-08-16T02:43:13", "url": "https://files.pythonhosted.org/packages/3f/cb/22731117c3634759aa0d3c97cc4aba9a2b1cda83e402f817e7785a65ea5f/oglhslack-0.1.4.2.tar.gz" } ], "0.1.4.2.1": [ { "comment_text": "", "digests": { "md5": "a0bad95ae8c402d406b5fe04a2bd400f", "sha256": "1abf8af067970cf8f46900cc257300c4d693492cbea468875744a3bb418b596f" }, "downloads": -1, "filename": "oglhslack-0.1.4.2.1.tar.gz", "has_sig": false, "md5_digest": "a0bad95ae8c402d406b5fe04a2bd400f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9691, "upload_time": "2017-08-16T02:50:22", "url": "https://files.pythonhosted.org/packages/a1/ef/b218f5e8d9c48f01008c85798d01bfdbd75e3a6051954a22fbf86254ff30/oglhslack-0.1.4.2.1.tar.gz" } ], "0.1.4.2.2": [ { "comment_text": "", "digests": { "md5": "7f78cc1cd6127a6df1cebaab0e6d5ed3", "sha256": "6e73d3eff76747f716ac547f0fc345d9c34300791e38127342d9645ac5d60c93" }, "downloads": -1, "filename": "oglhslack-0.1.4.2.2.tar.gz", "has_sig": false, "md5_digest": "7f78cc1cd6127a6df1cebaab0e6d5ed3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10144, "upload_time": "2017-08-16T02:59:08", "url": "https://files.pythonhosted.org/packages/f5/2f/158818537e2c71765f6c4efefc849a90506f22753b3ec3310848cea22e39/oglhslack-0.1.4.2.2.tar.gz" } ], "0.1.4.2.4": [ { "comment_text": "", "digests": { "md5": "9331c422190a4b7b74bf42c7a74d4485", "sha256": "1ccbbe746bb50b9807e7c386973fcd287ee3f1756fe763a3ce91c0668e65f0aa" }, "downloads": -1, "filename": "oglhslack-0.1.4.2.4.tar.gz", "has_sig": false, "md5_digest": "9331c422190a4b7b74bf42c7a74d4485", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13557, "upload_time": "2017-08-17T02:11:51", "url": "https://files.pythonhosted.org/packages/91/5f/8d322f98826155668bbb94b8c5d9cfd5a483371b39888ccb64778137ee2f/oglhslack-0.1.4.2.4.tar.gz" } ], "0.1.4.3": [ { "comment_text": "", "digests": { "md5": "6ed11209a5c137294d67ce29f04a7355", "sha256": "5d6b529780562fc40909757700156078d936ddb22a2e605782f29996b28573d3" }, "downloads": -1, "filename": "oglhslack-0.1.4.3.tar.gz", "has_sig": false, "md5_digest": "6ed11209a5c137294d67ce29f04a7355", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16609, "upload_time": "2017-08-20T21:47:23", "url": "https://files.pythonhosted.org/packages/08/62/ac8bf60bc4a5f12fade891ddb35c8b4c522dc0a978031bf1608651fb67e3/oglhslack-0.1.4.3.tar.gz" } ], "0.1.4.3.1": [ { "comment_text": "", "digests": { "md5": "2141d4a4eb0911092deeb51530eb0a73", "sha256": "3ffd8e8384b59946597cc281575fd1e0574daa9c9bbd96ac5a35960d35085ea4" }, "downloads": -1, "filename": "oglhslack-0.1.4.3.1.tar.gz", "has_sig": false, "md5_digest": "2141d4a4eb0911092deeb51530eb0a73", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16617, "upload_time": "2017-08-21T01:53:43", "url": "https://files.pythonhosted.org/packages/da/d8/896b8375507b57d08f6e32fb15f1c60da2cf39d9b104ec5cf5b517871584/oglhslack-0.1.4.3.1.tar.gz" } ], "0.1.4.4": [ { "comment_text": "", "digests": { "md5": "f912acf4c98fd5f0638a71813e10fc67", "sha256": "42ff62ba5e9be5708aa5f04722617a8d4728e08dea3b3339210a1684ceb79348" }, "downloads": -1, "filename": "oglhslack-0.1.4.4.tar.gz", "has_sig": false, "md5_digest": "f912acf4c98fd5f0638a71813e10fc67", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16941, "upload_time": "2017-08-21T12:18:47", "url": "https://files.pythonhosted.org/packages/9d/00/c0656cea85f2d2701866a116e0a8a2bc5fb6fa9f3632e4ac9091a9812e16/oglhslack-0.1.4.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "2941be875caa2fdd5b1b9d182b2cb753", "sha256": "ceb424151e15fe9c404bba776b2f52e32b52b046bf795dee4196a6d792b48c90" }, "downloads": -1, "filename": "oglhslack-0.1.5.tar.gz", "has_sig": false, "md5_digest": "2941be875caa2fdd5b1b9d182b2cb753", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16935, "upload_time": "2017-08-21T12:30:21", "url": "https://files.pythonhosted.org/packages/23/e0/9fc7761d57a9c9960c4700c204c3df23d71690fc038baeff45209739bb6b/oglhslack-0.1.5.tar.gz" } ], "0.1.5.2": [ { "comment_text": "", "digests": { "md5": "20fe4f338dce1d35c8ea65ef75c64afa", "sha256": "eb23edf8fd2bfa4168a7a4e273b8a23ccaa184ca0a0cdc98d6dbbbe515dd3ab7" }, "downloads": -1, "filename": "oglhslack-0.1.5.2.tar.gz", "has_sig": false, "md5_digest": "20fe4f338dce1d35c8ea65ef75c64afa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17156, "upload_time": "2017-08-22T10:42:34", "url": "https://files.pythonhosted.org/packages/23/ce/00b40eee6fe8589bc29e573df251bb563bc18da89ca9f9ff843e525a4ab5/oglhslack-0.1.5.2.tar.gz" } ], "0.1.5.3": [ { "comment_text": "", "digests": { "md5": "b22f438025006baa5c5fd9b449742fdb", "sha256": "6991af94af77027cb638b14e5783f630d5d14c409ef6ce8e8fa8048b7366bc44" }, "downloads": -1, "filename": "oglhslack-0.1.5.3.tar.gz", "has_sig": false, "md5_digest": "b22f438025006baa5c5fd9b449742fdb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17209, "upload_time": "2017-08-22T11:25:46", "url": "https://files.pythonhosted.org/packages/6b/df/93969321efa7a016da4f63cd59986fdbad4c1ac97daa1e33ea703cf1c49c/oglhslack-0.1.5.3.tar.gz" } ], "0.9": [ { "comment_text": "", "digests": { "md5": "fe9bc5a4dfa6943d1bc8286f7495920b", "sha256": "c6610f295c3cc20a1d824400342a062511a078595be3e9a4233368190b52890a" }, "downloads": -1, "filename": "oglhslack-0.9.tar.gz", "has_sig": false, "md5_digest": "fe9bc5a4dfa6943d1bc8286f7495920b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17314, "upload_time": "2017-08-25T06:23:20", "url": "https://files.pythonhosted.org/packages/ed/df/12d59a395326a87b2019681ba66c7cc05e100eb2ae42960fe31d05edd384/oglhslack-0.9.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "e3c968a873f1a7bb0729b03f7c0a9f7b", "sha256": "10903f4fe5419204f35688bce89d25d1cd4e78752a5d77677dbc14c50a96fc1c" }, "downloads": -1, "filename": "oglhslack-1.0.0.tar.gz", "has_sig": false, "md5_digest": "e3c968a873f1a7bb0729b03f7c0a9f7b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17492, "upload_time": "2017-10-10T13:28:19", "url": "https://files.pythonhosted.org/packages/8f/a6/bb80324f0d241a3abfc282c8e5f64a8d44419bcb393cf83bee8de3ef98bf/oglhslack-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e3c968a873f1a7bb0729b03f7c0a9f7b", "sha256": "10903f4fe5419204f35688bce89d25d1cd4e78752a5d77677dbc14c50a96fc1c" }, "downloads": -1, "filename": "oglhslack-1.0.0.tar.gz", "has_sig": false, "md5_digest": "e3c968a873f1a7bb0729b03f7c0a9f7b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17492, "upload_time": "2017-10-10T13:28:19", "url": "https://files.pythonhosted.org/packages/8f/a6/bb80324f0d241a3abfc282c8e5f64a8d44419bcb393cf83bee8de3ef98bf/oglhslack-1.0.0.tar.gz" } ] }