# FlowTask #
FlowTask is a plugin-based, component-driven task execution framework for create complex Tasks.
FlowTask runs Tasks defined in JSON, YAML or TOML files, any Task is a combination of Components,
and every component in the Task run sequentially or depend of others, like a DAG.
Can create a Task combining Commands, Shell scripts and other specific Components (as TableInput: Open a Table using a datasource, DownloadFromIMAP: Download a File from a IMAP Folder, and so on), any Python Callable can be a Component inside a Task, or can extends UserComponent to build your own componets.
Every designed Task can run from CLI, programmatically, via RESTful API (using our aioHTTP-based Handler), called by WebHooks or even dispatched to a external Worker using our built-in Scheduler.
## Quickstart ##
```console
pip install flowtask
```
Tasks can organizated into directory structure like this:
tasks /
├── programs /
├── test /
├── tasks /
The main reason of this structure, is maintain organized several tasks by tenant/program, avoiding filling a directory with several task files.
FlowTask support "TaskStorage", a Task Storage is the main repository for tasks, main Task Storage is a directory in any filesystem path (optionally you can syncronize that path using git), but Tasks can be saved onto a Database or a S3 bucket.
## Dependencies ##
* aiohttp (Asyncio Web Framework and Server) (required by navigator)
* AsyncDB
* QuerySource
* Navigator-api
* (Optional) Qworker (for distributing asyncio Tasks on distributed workers).
## Features ##
* Component-based Task execution framework with several components covering several actions (download files, create pandas dataframes from files, mapping dataframe columns to a json-dictionary, etc)
* Built-in API for execution of Tasks.
### How I run a Task? ###
Can run a Task from CLI:
```console
task --program=test --task=example
```
on CLI, you can pass an ENV (enviroment) to change the environment file on task execution.
```console
ENV=dev task --program=test --task=example
```
or Programmatically:
```python
from flowtask import Task
import asyncio
task = Task(program='test', task='example')
results = asyncio.run(task.run())
# we can alternatively, using the execution mode of task object:
results = asyncio.run(task())
```
### Requirements ###
* Python >= 3.9
* asyncio (https://pypi.python.org/pypi/asyncio/)
* aiohttp >= 3.6.2
### Contribution guidelines ###
Please have a look at the Contribution Guide
* Writing tests
* Code review
* Other guidelines
### Who do I talk to? ###
* Repo owner or admin
* Other community or team contact
### License ###
Navigator is licensed under Apache 2.0 License. See the LICENSE file for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "flowtask",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10.1",
"maintainer_email": null,
"keywords": "Flowtask, Data Integration, Task Orchestration, Task-Runner, Pipelines",
"author": null,
"author_email": "Jesus Lara <jesuslarag@gmail.com>",
"download_url": null,
"platform": null,
"description": "# FlowTask #\n\nFlowTask is a plugin-based, component-driven task execution framework for create complex Tasks.\n\nFlowTask runs Tasks defined in JSON, YAML or TOML files, any Task is a combination of Components,\nand every component in the Task run sequentially or depend of others, like a DAG.\n\nCan create a Task combining Commands, Shell scripts and other specific Components (as TableInput: Open a Table using a datasource, DownloadFromIMAP: Download a File from a IMAP Folder, and so on), any Python Callable can be a Component inside a Task, or can extends UserComponent to build your own componets.\n\nEvery designed Task can run from CLI, programmatically, via RESTful API (using our aioHTTP-based Handler), called by WebHooks or even dispatched to a external Worker using our built-in Scheduler.\n\n## Quickstart ##\n\n```console\npip install flowtask\n```\n\nTasks can organizated into directory structure like this:\n\ntasks /\n \u251c\u2500\u2500 programs /\n \u251c\u2500\u2500 test /\n \u251c\u2500\u2500 tasks /\n\nThe main reason of this structure, is maintain organized several tasks by tenant/program, avoiding filling a directory with several task files.\n\nFlowTask support \"TaskStorage\", a Task Storage is the main repository for tasks, main Task Storage is a directory in any filesystem path (optionally you can syncronize that path using git), but Tasks can be saved onto a Database or a S3 bucket.\n\n## Dependencies ##\n\n * aiohttp (Asyncio Web Framework and Server) (required by navigator)\n * AsyncDB\n * QuerySource\n * Navigator-api\n * (Optional) Qworker (for distributing asyncio Tasks on distributed workers).\n\n## Features ##\n\n* Component-based Task execution framework with several components covering several actions (download files, create pandas dataframes from files, mapping dataframe columns to a json-dictionary, etc)\n* Built-in API for execution of Tasks.\n\n### How I run a Task? ###\n\nCan run a Task from CLI:\n```console\ntask --program=test --task=example\n```\n\non CLI, you can pass an ENV (enviroment) to change the environment file on task execution.\n```console\nENV=dev task --program=test --task=example\n```\n\nor Programmatically:\n```python\nfrom flowtask import Task\nimport asyncio\n\ntask = Task(program='test', task='example')\nresults = asyncio.run(task.run())\n# we can alternatively, using the execution mode of task object:\nresults = asyncio.run(task())\n```\n\n### Requirements ###\n\n* Python >= 3.9\n* asyncio (https://pypi.python.org/pypi/asyncio/)\n* aiohttp >= 3.6.2\n\n### Contribution guidelines ###\n\nPlease have a look at the Contribution Guide\n\n* Writing tests\n* Code review\n* Other guidelines\n\n### Who do I talk to? ###\n\n* Repo owner or admin\n* Other community or team contact\n\n### License ###\n\nNavigator is licensed under Apache 2.0 License. See the LICENSE file for more details.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Framework for Task orchestration",
"version": "5.9.8",
"project_urls": {
"Funding": "https://paypal.me/phenobarbital",
"Homepage": "https://github.com/phenobarbital/flowtask",
"Say Thanks!": "https://saythanks.io/to/phenobarbital",
"Source": "https://github.com/phenobarbital/flowtask"
},
"split_keywords": [
"flowtask",
" data integration",
" task orchestration",
" task-runner",
" pipelines"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5009e42514bb027d0917057c55dbcc200323886837d65684f29df9755363b342",
"md5": "e787d39483aed0c3c274486d036c6420",
"sha256": "55af86060e781a1c577d42a3c1b133cee67d4df56f1154d98ee6d95f91b61c2a"
},
"downloads": -1,
"filename": "flowtask-5.9.8-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
"has_sig": false,
"md5_digest": "e787d39483aed0c3c274486d036c6420",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.10.1",
"size": 3843566,
"upload_time": "2025-08-25T22:48:24",
"upload_time_iso_8601": "2025-08-25T22:48:24.745931Z",
"url": "https://files.pythonhosted.org/packages/50/09/e42514bb027d0917057c55dbcc200323886837d65684f29df9755363b342/flowtask-5.9.8-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3af5125e4f0c1794aa7d0db45df6cbc16e2b99385edab92b3a1e7177343a9333",
"md5": "59851934afbe0358a4f85eda87892e36",
"sha256": "1b98a102aae2b2e2516aa40b747922941dd3f6e6fc4857ea27e92d2e59e371df"
},
"downloads": -1,
"filename": "flowtask-5.9.8-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
"has_sig": false,
"md5_digest": "59851934afbe0358a4f85eda87892e36",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.10.1",
"size": 4020808,
"upload_time": "2025-08-25T22:48:27",
"upload_time_iso_8601": "2025-08-25T22:48:27.068967Z",
"url": "https://files.pythonhosted.org/packages/3a/f5/125e4f0c1794aa7d0db45df6cbc16e2b99385edab92b3a1e7177343a9333/flowtask-5.9.8-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f73748690cc9234647a3ca47255ff7226f768172340797056a94b62951563e39",
"md5": "b29b460ba25622d3aeb0091b39c58d99",
"sha256": "0f301eaba546d605a6956cb0184bc684a96f9305a2b8e76eb7cc427c662e3175"
},
"downloads": -1,
"filename": "flowtask-5.9.8-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
"has_sig": false,
"md5_digest": "b29b460ba25622d3aeb0091b39c58d99",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.10.1",
"size": 4186383,
"upload_time": "2025-08-25T22:48:28",
"upload_time_iso_8601": "2025-08-25T22:48:28.460978Z",
"url": "https://files.pythonhosted.org/packages/f7/37/48690cc9234647a3ca47255ff7226f768172340797056a94b62951563e39/flowtask-5.9.8-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-25 22:48:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "phenobarbital",
"github_project": "flowtask",
"github_not_found": true,
"lcname": "flowtask"
}
JSON
