{ "info": { "author": "Julien LEICHER", "author_email": "julien@leicher.me", "bugtrack_url": null, "classifiers": [ "Programming Language :: Python :: 3" ], "description": "pytlas-broker |travis| |cover| |pypi| |license|\n===============================================\n\n.. |travis| image:: https://travis-ci.org/atlassistant/pytlas-broker.svg?branch=master\n :target: https://travis-ci.org/atlassistant/pytlas-broker\n\n.. |cover| image:: https://codecov.io/gh/atlassistant/pytlas-broker/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/atlassistant/pytlas-broker\n\n.. |pypi| image:: https://badge.fury.io/py/pytlas-broker.svg\n :target: https://badge.fury.io/py/pytlas-broker\n\n.. |license| image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg\n :target: https://www.gnu.org/licenses/gpl-3.0\n\nLibrary and Command Line Utilities to communicate with the\n`pytlas open-source assistant `_ using\nchannels (such as GSM or MQTT).\n\nPurpose\n-------\n\nIt wraps the **pytlas** library in a tiny **server** accessible from multiple\n**channels** to make it easy to create clients in the language of your choice\nto trigger user agents.\n\nInstallation\n------------\n\n.. code-block:: bash\n\n $ pip install pytlas_broker # Gets the latest release from pypi\n $ git clone https://github.com/atlassistant/pytlas-broker && cd pytlas-broker && pip install -e . # or directly from source\n\nGetting started\n---------------\n\nFor now, both the server and the client CLI communicates with an MQTT server. If\nyou wish to provider host, port and credentials, just sets pytlas settings in the\n**mqtt** section:\n\n.. code-block:: ini\n\n [pytlas]\n skills_dir=skills/\n\n [mqtt]\n host=localhost\n port=1883\n username=\n password=\n\nServer\n~~~~~~\n\nAt the moment, the CLI will serve agents loaded from a configuration folder using\nMQTT.\n\nIt assumes the following directory structure:\n\n- your_data_folder/\n \n - default/ # Represents the default directory if the user does not have one\n \n - skills/ # Referenced via the below pytlas.ini file\n - cache/ # Cache folder for pytlas interpreter\n - pytlas.ini # This file will be loaded at startup by the CLI for initial configuration\n \n - john/\n \n - cache/ # Cache folder specific for that user\n - pytlas.ini # May override settings for this user only\n\nWhen the server receive a message from an opened channel, it will create an agent\nfor the user (if it doesn't exist yet) and answer on the last available channel\nfor that user.\n\nTo start the broker, use the following command:\n\n.. code-block:: bash\n\n $ pytlas-broker serve your_data_folder/\n\nAnd if you have already cloned the **pytlas** repository in the previous folder,\nyou can serve the examples right away using:\n\n.. code-block:: bash\n\n $ pytlas-broker serve ../pytlas/ --default example\n\nClient\n~~~~~~\n\nOnce your server is running, you can start a tiny REPL client with the command:\n\n.. code-block:: bash\n\n $ pytlas-broker repl\n\nTesting\n-------\n\n.. code-block:: bash\n\n $ pip install -e .[test]\n $ python -m nose --with-doctest -v --with-coverage --cover-package=pytlas_broker\n\nLinting\n-------\n\n.. code-block:: bash\n\n $ pylint --rcfile .pylintrc pytlas_broker setup.py # in the root directory", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/atlassistant/pytlas-broker", "keywords": "", "license": "GPL-3.0", "maintainer": "", "maintainer_email": "", "name": "pytlas-broker", "package_url": "https://pypi.org/project/pytlas-broker/", "platform": "", "project_url": "https://pypi.org/project/pytlas-broker/", "project_urls": { "Documentation": "https://pytlas-broker.readthedocs.io/", "Homepage": "https://github.com/atlassistant/pytlas-broker", "Source": "https://github.com/atlassistant/pytlas-broker", "Tracker": "https://github.com/atlassistant/pytlas-broker/issues" }, "release_url": "https://pypi.org/project/pytlas-broker/1.0.0/", "requires_dist": null, "requires_python": "", "summary": "Wrap the pytlas library across multiple channels", "version": "1.0.0" }, "last_serial": 5950386, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "c7b6132d0b9e8bc9b556aabe1a9986b5", "sha256": "73bd69dba645698c5402e5da44ca20dce673656ecc3978455b95cb39d5745ce4" }, "downloads": -1, "filename": "pytlas_broker-1.0.0.tar.gz", "has_sig": false, "md5_digest": "c7b6132d0b9e8bc9b556aabe1a9986b5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15336, "upload_time": "2019-10-09T15:06:27", "url": "https://files.pythonhosted.org/packages/77/aa/30ec7583607e29047078a4b0112619631abf6a8635451171eaad00702170/pytlas_broker-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c7b6132d0b9e8bc9b556aabe1a9986b5", "sha256": "73bd69dba645698c5402e5da44ca20dce673656ecc3978455b95cb39d5745ce4" }, "downloads": -1, "filename": "pytlas_broker-1.0.0.tar.gz", "has_sig": false, "md5_digest": "c7b6132d0b9e8bc9b556aabe1a9986b5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15336, "upload_time": "2019-10-09T15:06:27", "url": "https://files.pythonhosted.org/packages/77/aa/30ec7583607e29047078a4b0112619631abf6a8635451171eaad00702170/pytlas_broker-1.0.0.tar.gz" } ] }