{ "info": { "author": "Kidx NLP", "author_email": "nlp@mykidx.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Libraries" ], "description": "# Rasa Python-SDK\n[![Join the chat on Rasa Community Forum](https://img.shields.io/badge/forum-join%20discussions-brightgreen.svg)](https://forum.rasa.com/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n[![Build Status](https://travis-ci.com/RasaHQ/rasa_core_sdk.svg?branch=master)](https://travis-ci.com/RasaHQ/rasa_core_sdk)\n[![PyPI version](https://img.shields.io/pypi/v/rasa_core_sdk.svg)](https://pypi.python.org/pypi/rasa-core-sdk)\n[![Documentation Status](https://img.shields.io/badge/docs-stable-brightgreen.svg)](https://rasa.com/docs/core)\n\nPython SDK for the development of custom actions for Kidx Core.\n\n## Installation\n\nTo install the SDK run\n\n```bash\npip install kidx_core_sdk\n```\n\n## Compatibility\n\n| SDK version | compatible Rasa Core version |\n|---------------|----------------------------------------|\n| `0.12.x` | `>=0.12.x` |\n| `0.11.x` | `0.11.x` |\n| not compatible | `<=0.10.x` |\n\n## Usage\n\nDetailed instructions can be found in the Rasa Core Documentation about\n[Custom Actions](https://rasa.com/docs/core/customactions).\n\n## Docker\n\n### Usage\n\nIn order to start an action server using implemented custom actions,\nyou can use the available Docker image `rasa/rasa_core_sdk:latest`.\n\nBefore starting the action server ensure that the folder containing\nyour actions is handled as Python module and therefore has to contain\na file called `__init__.py`\n\nThen start the action server using:\n\n```bash\ndocker run -p 5055:5055 --mount type=bind,source=,target=/app/actions \\\n\tkidx/kidx_core_sdk:latest\n```\n\nThe action server is then avaible at `http://localhost:5055/webhook`.\n\n### Custom Dependencies\n\nTo add custom dependencies you enhance the given Docker image, e.g.:\n\n```\nFROM kidx/kidx_core_sdk:latest\n\n# To install system dependencies\nRUN apt-get update -qq && \\\n apt-get install -y && \\\n apt-get clean && \\\n rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*\n\n# To install packages from PyPI\nRUN pip install --no-cache-dir \n```\n\n## Code Style\n\nTo ensure a standardized code style we use the formatter [black](https://github.com/ambv/black).\nIf your code is not formatted properly, travis will fail to build.\n\nIf you want to automatically format your code on every commit, you can use [pre-commit](https://pre-commit.com/).\nJust install it via `pip install pre-commit` and execute `pre-commit install`.\n\nIf you want to set it up manually, install black via `pip install black`.\nTo reformat files execute\n```\nblack .\n```\n\n## Development Internals\n### Running and changing the unit test\nTo build & edit the docs, first install all necessary dependencies:\n\n```\ndocker build -f Dockerfile.dev . -t kidx_core_sdk_dev\ndocker run --name kidx_core_sdk_dev -v \"$PWD\":/app -it kidx_core_sdk_dev bash\n```\n\nAfter the docker container start run command in docker\n```\npip install -e . --no-cache-dir -i https://mirrors.aliyun.com/pypi/simple/\nmake lint\nmake test\n```\n\nLook the coverage should be no failure and pass 100%\n\n\n## License\nLicensed under the Apache License, Version 2.0. Copyright 2019 Kidx\nTechnologies GmbH. [Copy of the license](LICENSE.txt).\n\nA list of the Licenses of the dependencies of the project can be found at\nthe bottom of the\n[Libraries Summary](https://libraries.io/github/RasaHQ/rasa_core_sdk).\n", "description_content_type": "", "docs_url": null, "download_url": "http://git.mykidx.com/nlp/kidx_core_sdk/-/archive/0.0.1a2/kidx_core_sdk-0.0.1a2.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://rasa.com", "keywords": "nlp machine-learning machine-learning-library bot bots botkit kidx conversational-agents conversational-ai chatbotchatbot-framework bot-framework", "license": "Apache 2.0", "maintainer": "", "maintainer_email": "", "name": "kidx-core-sdk", "package_url": "https://pypi.org/project/kidx-core-sdk/", "platform": "", "project_url": "https://pypi.org/project/kidx-core-sdk/", "project_urls": { "Download": "http://git.mykidx.com/nlp/kidx_core_sdk/-/archive/0.0.1a2/kidx_core_sdk-0.0.1a2.tar.gz", "Homepage": "https://rasa.com" }, "release_url": "https://pypi.org/project/kidx-core-sdk/0.0.1a2/", "requires_dist": null, "requires_python": "", "summary": "Machine learning based dialogue engine for conversational software.", "version": "0.0.1a2" }, "last_serial": 5175258, "releases": { "0.0.1a1": [ { "comment_text": "", "digests": { "md5": "679c83eb66b66e51e6b2f1acfd6ab77d", "sha256": "6b3095a46bd5091ecdb97aae12137eb33f9185f5a88033c80959579adbfb989a" }, "downloads": -1, "filename": "kidx_core_sdk-0.0.1a1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "679c83eb66b66e51e6b2f1acfd6ab77d", "packagetype": "bdist_wheel", "python_version": "3.7", "requires_python": null, "size": 20409, "upload_time": "2019-04-15T12:10:04", "url": "https://files.pythonhosted.org/packages/bd/ff/9ef4a12b8f137ecc0c12d59c3904aaf1e99a3f62ee91a35c4459b977e689/kidx_core_sdk-0.0.1a1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "97cb00d1cfb7fe762f4c7a40c5c1eee1", "sha256": "b43ace0610f4fa15a1a42672cd20d7bc2d0614c3d7535086ee0bc599bd5f42ce" }, "downloads": -1, "filename": "kidx-core-sdk-0.0.1a1.tar.gz", "has_sig": false, "md5_digest": "97cb00d1cfb7fe762f4c7a40c5c1eee1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15862, "upload_time": "2019-04-15T11:53:50", "url": "https://files.pythonhosted.org/packages/13/ed/c7a9a9a45f5137d47ece5543e68f650307c2957533959c85d97dac9b98ca/kidx-core-sdk-0.0.1a1.tar.gz" } ], "0.0.1a2": [ { "comment_text": "", "digests": { "md5": "8c2baee0707cf542f56ba002ba7057e0", "sha256": "2b455cf77255181b4813051e1d834959ebed46ac4c50b689d477ef2f3f1c962d" }, "downloads": -1, "filename": "kidx_core_sdk-0.0.1a2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "8c2baee0707cf542f56ba002ba7057e0", "packagetype": "bdist_wheel", "python_version": "3.7", "requires_python": null, "size": 20547, "upload_time": "2019-04-23T02:31:36", "url": "https://files.pythonhosted.org/packages/24/34/0aae0a870568e751ad9b46b72f363755ca58181b7062dd1fbaf1d60d2c8e/kidx_core_sdk-0.0.1a2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "65c6d34688641448a7c25d4ad15729ae", "sha256": "bcc5a2eae0e6d45244a8657c513c4be244a52c73f94a97854ea8eccb500691e5" }, "downloads": -1, "filename": "kidx-core-sdk-0.0.1a2.tar.gz", "has_sig": false, "md5_digest": "65c6d34688641448a7c25d4ad15729ae", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15946, "upload_time": "2019-04-23T02:31:33", "url": "https://files.pythonhosted.org/packages/bf/7c/6f5763071f9f9978d5a22858f9655f224e85c7e603aef741803ccf7f18dc/kidx-core-sdk-0.0.1a2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8c2baee0707cf542f56ba002ba7057e0", "sha256": "2b455cf77255181b4813051e1d834959ebed46ac4c50b689d477ef2f3f1c962d" }, "downloads": -1, "filename": "kidx_core_sdk-0.0.1a2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "8c2baee0707cf542f56ba002ba7057e0", "packagetype": "bdist_wheel", "python_version": "3.7", "requires_python": null, "size": 20547, "upload_time": "2019-04-23T02:31:36", "url": "https://files.pythonhosted.org/packages/24/34/0aae0a870568e751ad9b46b72f363755ca58181b7062dd1fbaf1d60d2c8e/kidx_core_sdk-0.0.1a2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "65c6d34688641448a7c25d4ad15729ae", "sha256": "bcc5a2eae0e6d45244a8657c513c4be244a52c73f94a97854ea8eccb500691e5" }, "downloads": -1, "filename": "kidx-core-sdk-0.0.1a2.tar.gz", "has_sig": false, "md5_digest": "65c6d34688641448a7c25d4ad15729ae", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15946, "upload_time": "2019-04-23T02:31:33", "url": "https://files.pythonhosted.org/packages/bf/7c/6f5763071f9f9978d5a22858f9655f224e85c7e603aef741803ccf7f18dc/kidx-core-sdk-0.0.1a2.tar.gz" } ] }