Framework for running Tasks and from CLI and API for orchestation. Component-based Task builder/Runner for non-programmers.
Project description
FlowTask DataIntegration
FlowTask DataIntegration 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
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:
task --program=test --task=example
on CLI, you can pass an ENV (enviroment) to change the environment file on task execution.
ENV=dev task --program=test --task=example
or Programmatically:
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for flowtask-5.1.16-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b377c457be0c798979be63d7da2c97bd6117cb2b5c24704a7081e70f49fa82d |
|
MD5 | 5b933b715edf5bce07d338d3a0be32d9 |
|
BLAKE2b-256 | 215682543286dac89abec45c6a1937c3f6f1c2a860c7cdef6794dcdec5a1d0e0 |
Hashes for flowtask-5.1.16-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24c772c8b8e22cfa3ecf3c5741866f5ee24b6bc714e41daeaa139a40b1397c0c |
|
MD5 | e2c07abd73e0e8f47306ef311f6a1638 |
|
BLAKE2b-256 | c03b972a4bd34e7b014cd54d5b5879c798d5f808ab6e615fd3d298bc518ab08f |
Hashes for flowtask-5.1.16-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1f7a39f6d8286c9a20cd9e9c0a3cda841eaf5e7eeaa95b69a7809f9719b575c |
|
MD5 | e1acd10de862ff6b3058245ba6cdf3f6 |
|
BLAKE2b-256 | ffdc2b23f64ac8213d7db1af3d65b5c7032fecf68df0f6a32d343c76da51f11e |