# Taskflow Python-SDK
[](https://forum.taskflow.com/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://github.com/TaskflowHQ/taskflow-sdk/actions/runs/)
[](https://coveralls.io/github/TaskflowHQ/taskflow-sdk?branch=main)
[](https://pypi.python.org/pypi/taskflow-sdk)
Python SDK for the development of custom actions for Taskflow.
<hr />
💡 **We're migrating issues to Jira** 💡
Starting January 2023, issues for Taskflow Open Source are located in
[this Jira board](https://taskflow-open-source.atlassian.net/browse/OSS). You can browse issues without being logged in;
if you want to create issues, you'll need to create a Jira account.
<hr />
## Installation
To install the SDK run
```bash
pip install taskflow-sdk
```
## Compatibility
`taskflow-sdk` package:
| SDK version | compatible Taskflow version |
|----------------|-----------------------------------|
| `1.0.x` | `>=1.0.x` |
old `taskflow_core_sdk` package:
| SDK version | compatible Taskflow Core version |
|----------------|----------------------------------------|
| `0.12.x` | `>=0.12.x` |
| `0.11.x` | `0.11.x` |
| not compatible | `<=0.10.x` |
## Usage
Detailed instructions can be found in the Taskflow Documentation about
[Custom Actions](https://taskflow.com/docs/taskflow/core/actions).
## Docker
### Usage
In order to start an action server using implemented custom actions,
you can use the available Docker image `taskflow/taskflow-sdk`.
Before starting the action server ensure that the folder containing
your actions is handled as Python module and therefore has to contain
a file called `__init__.py`
Then start the action server using:
```bash
docker run -p 5055:5055 --mount type=bind,source=<ABSOLUTE_PATH_TO_YOUR_ACTIONS>,target=/app/actions \
taskflow/taskflow-sdk:<version>
```
The action server is then available at `http://localhost:5055/webhook`.
### Custom Dependencies
To add custom dependencies you enhance the given Docker image, e.g.:
```
# Extend the official Taskflow SDK image
FROM taskflow/taskflow-sdk:<version>
# Change back to root user to install dependencies
USER root
# To install system dependencies
RUN apt-get update -qq && \
apt-get install -y <NAME_OF_REQUIRED_PACKAGE> && \
apt-get clean && \
rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
# To install packages from PyPI
RUN pip install --no-cache-dir <A_REQUIRED_PACKAGE_ON_PYPI>
# Switch back to non-root to run code
USER 1001
```
## Building from source
Taskflow SDK uses Poetry for packaging and dependency management. If you want to build it from source,
you have to install Poetry first. This is how it can be done:
```
curl -sSL https://install.python-poetry.org | python3 -
```
There are several other ways to install Poetry. Please, follow
[the official guide](https://python-poetry.org/docs/#installation) to see all possible options.
To install dependencies and `taskflow-sdk` itself in editable mode execute
```
make install
```
## Code Style
To ensure a standardized code style we use the formatter [ruff](https://github.com/astral-sh/ruff).
If your code is not formatted properly, GitHub CI will fail to build.
If you want to automatically format your code on every commit, you can use [pre-commit](https://pre-commit.com/).
Just install it via `pip install pre-commit` and execute `pre-commit install`.
To check and reformat files execute
```
make lint
```
## Steps to release a new version
Releasing a new version is quite simple, as the packages are build and distributed
by GitHub Actions.
*Release steps*:
1. Switch to the branch you want to cut the release from (`main` in case of a
major / minor, the current release branch for patch releases).
2. If this is a minor / major release: Make sure all fixes from currently supported minor versions have been merged from their respective release branches (e.g. 3.3.x) back into main.
3. Run `make release`
4. Create a PR against main or the release branch (e.g. `1.2.x`)
5. **If this is a minor release**, a new release branch should be created
pointing to the same commit as the tag to allow for future patch releases,
e.g.
```bash
git checkout -b 1.2.x
git push origin 1.2.x
```
## License
Licensed under the Apache License, Version 2.0. Copyright 2021 Taskflow
Technologies GmbH. [Copy of the license](LICENSE.txt).
A list of the Licenses of the dependencies of the project can be found at
the bottom of the
[Libraries Summary](https://libraries.io/github/TaskflowHQ/taskflow-sdk).
Raw data
{
"_id": null,
"home_page": "https://taskflow.com",
"name": "taskflow-sdk",
"maintainer": "Tom Bocklisch",
"docs_url": null,
"requires_python": "<3.11,>=3.8",
"maintainer_email": "tom@taskflow.com",
"keywords": "nlp, machine-learning, machine-learning-library, bot, bots, botkit, taskflow conversational-agents, conversational-ai, chatbot, chatbot-framework, bot-framework",
"author": "Taskflow Technologies GmbH",
"author_email": "hi@taskflow.com",
"download_url": "https://files.pythonhosted.org/packages/c7/eb/effc9941da6843143bb7fb04c9e1f3f628bfc7226e2fade3f5b28a09c1a6/taskflow_sdk-3.10.1.tar.gz",
"platform": null,
"description": "# Taskflow Python-SDK\n[](https://forum.taskflow.com/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n[](https://github.com/TaskflowHQ/taskflow-sdk/actions/runs/)\n[](https://coveralls.io/github/TaskflowHQ/taskflow-sdk?branch=main)\n[](https://pypi.python.org/pypi/taskflow-sdk)\n\nPython SDK for the development of custom actions for Taskflow.\n\n<hr />\n\n\ud83d\udca1 **We're migrating issues to Jira** \ud83d\udca1\n\nStarting January 2023, issues for Taskflow Open Source are located in\n[this Jira board](https://taskflow-open-source.atlassian.net/browse/OSS). You can browse issues without being logged in;\nif you want to create issues, you'll need to create a Jira account.\n\n<hr />\n\n## Installation\n\nTo install the SDK run\n\n```bash\npip install taskflow-sdk\n```\n\n## Compatibility\n\n`taskflow-sdk` package:\n\n| SDK version | compatible Taskflow version |\n|----------------|-----------------------------------|\n| `1.0.x` | `>=1.0.x` |\n\nold `taskflow_core_sdk` package:\n\n| SDK version | compatible Taskflow 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 Taskflow Documentation about\n[Custom Actions](https://taskflow.com/docs/taskflow/core/actions).\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 `taskflow/taskflow-sdk`.\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=<ABSOLUTE_PATH_TO_YOUR_ACTIONS>,target=/app/actions \\\n\ttaskflow/taskflow-sdk:<version>\n```\n\nThe action server is then available at `http://localhost:5055/webhook`.\n\n### Custom Dependencies\n\nTo add custom dependencies you enhance the given Docker image, e.g.:\n\n```\n# Extend the official Taskflow SDK image\nFROM taskflow/taskflow-sdk:<version>\n\n# Change back to root user to install dependencies\nUSER root\n\n# To install system dependencies\nRUN apt-get update -qq && \\\n apt-get install -y <NAME_OF_REQUIRED_PACKAGE> && \\\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 <A_REQUIRED_PACKAGE_ON_PYPI>\n\n# Switch back to non-root to run code\nUSER 1001\n```\n\n## Building from source\n\nTaskflow SDK uses Poetry for packaging and dependency management. If you want to build it from source,\nyou have to install Poetry first. This is how it can be done:\n\n```\ncurl -sSL https://install.python-poetry.org | python3 -\n```\n\nThere are several other ways to install Poetry. Please, follow\n[the official guide](https://python-poetry.org/docs/#installation) to see all possible options.\n\nTo install dependencies and `taskflow-sdk` itself in editable mode execute\n```\nmake install\n```\n\n## Code Style\n\nTo ensure a standardized code style we use the formatter [ruff](https://github.com/astral-sh/ruff).\nIf your code is not formatted properly, GitHub CI 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\nTo check and reformat files execute\n```\nmake lint\n```\n\n## Steps to release a new version\nReleasing a new version is quite simple, as the packages are build and distributed\nby GitHub Actions.\n\n*Release steps*:\n1. Switch to the branch you want to cut the release from (`main` in case of a\n major / minor, the current release branch for patch releases).\n2. If this is a minor / major release: Make sure all fixes from currently supported minor versions have been merged from their respective release branches (e.g. 3.3.x) back into main.\n3. Run `make release`\n4. Create a PR against main or the release branch (e.g. `1.2.x`)\n5. **If this is a minor release**, a new release branch should be created\n pointing to the same commit as the tag to allow for future patch releases,\n e.g.\n ```bash\n git checkout -b 1.2.x\n git push origin 1.2.x\n ```\n\n## License\nLicensed under the Apache License, Version 2.0. Copyright 2021 Taskflow\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/TaskflowHQ/taskflow-sdk).\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Open source machine learning framework to automate text- and voice-based conversations: NLU, dialogue management, connect to Slack, Facebook, and more - Create chatbots and voice assistants",
"version": "3.10.1",
"project_urls": {
"Documentation": "https://taskflow.com/docs",
"Homepage": "https://taskflow.com",
"Repository": "https://github.com/taskflowhq/taskflow-sdk"
},
"split_keywords": [
"nlp",
" machine-learning",
" machine-learning-library",
" bot",
" bots",
" botkit",
" taskflow conversational-agents",
" conversational-ai",
" chatbot",
" chatbot-framework",
" bot-framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc047cd6d45577c20e0d1519dbc3f82c01ae6ca61fd49859a476473546b10210",
"md5": "1c39dffe888e4abce859eed75f83df6f",
"sha256": "152dfded1f6accf458f61d74b687c8150e616db6ff01f9ed07b5ac66c62f3bd6"
},
"downloads": -1,
"filename": "taskflow_sdk-3.10.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c39dffe888e4abce859eed75f83df6f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>=3.8",
"size": 64339,
"upload_time": "2024-11-03T14:38:05",
"upload_time_iso_8601": "2024-11-03T14:38:05.033206Z",
"url": "https://files.pythonhosted.org/packages/fc/04/7cd6d45577c20e0d1519dbc3f82c01ae6ca61fd49859a476473546b10210/taskflow_sdk-3.10.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c7ebeffc9941da6843143bb7fb04c9e1f3f628bfc7226e2fade3f5b28a09c1a6",
"md5": "ab975f0de7574b06266990c27717da18",
"sha256": "71810287e8877ea8fab59ec45706bf7bc8102a6f63b847be896a2a14d0f4fb49"
},
"downloads": -1,
"filename": "taskflow_sdk-3.10.1.tar.gz",
"has_sig": false,
"md5_digest": "ab975f0de7574b06266990c27717da18",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.8",
"size": 49459,
"upload_time": "2024-11-03T14:38:07",
"upload_time_iso_8601": "2024-11-03T14:38:07.101170Z",
"url": "https://files.pythonhosted.org/packages/c7/eb/effc9941da6843143bb7fb04c9e1f3f628bfc7226e2fade3f5b28a09c1a6/taskflow_sdk-3.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-03 14:38:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "taskflowhq",
"github_project": "taskflow-sdk",
"github_not_found": true,
"lcname": "taskflow-sdk"
}
JSON
