Skip to main content

The lean workflow automation framework for machines with heart.

Project description

joeflow

The lean workflow automation framework for machines with heart.

a hand drawn robot

Joeflow is a free workflow automation framework designed to bring simplicity to complex workflows. Joeflow written in Python based on the world famous Django web framework.

Here is a little sample of what a workflow written in joeflow may look like:

from django.core.mail import send_mail
from jowflow.models import WorkflowState
from joeflow import tasks
from joeflow.workflows import Workflow


class Shipment(WorkflowState):
    email = models.EmailField(blank=True)
    shipping_address = models.TextField()
    tracking_code = models.TextField()

class ShippingWorkflow(Shipment, Workflow):
    checkout = tasks.StartView(fields=["shipping_address", "email"])

    ship = tasks.UpdateView(fields=["tracking_code"])

    def has_email(self):
        if self.email:
            return [self.send_tracking_code]

    def send_tracking_code(self):
        send_mail(
            subject="Your tracking code",
            message=self.tracking_code,
            from_email=None,
            recipient_list=[self.email],
        )

    def end(self, task):
        pass

    edges = [
        (checkout, ship),
        (ship, has_email),
        (has_email, send_tracking_code),
        (has_email, end),
        (send_tracking_code, end),
    ]

Design Principles

Common sense is better than convention

Joeflow does not follow any academic modeling notation developed by a poor PhD student who actually never worked a day in their life. Businesses are already complex which is why Joeflow is rather simple. There are only two types of tasks – human & machine – as well as edges to connect them. It’s so simple a toddler (or your CEO) could design a workflow.

Lean Automation (breaking the rules)

Things don’t always go according to plan especially when humans are involved. Even the best workflow can’t cover all possible edge cases. Joeflow embraces that fact. It allows uses to interrupt a workflow at any given point and modify it’s current state. All while tracking all changes. This allows developers to automate the main cases and users handle manually exceptions. This allows you businesses to ship prototypes and MVPs of workflows. Improvements can be shipped in multiple iterations without disrupting the business.

People

Joeflow is build with all users in mind. Managers should be able to develop better workflows. Users should able to interact with the tasks every single day. And developers should be able to rapidly develop and test new features.

Free

Joeflow is open source and collaboratively developed by industry leaders in automation and digital innovation.

Photo by rawpixel.com from Pexels

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

joeflow-1.2.0.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

joeflow-1.2.0-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file joeflow-1.2.0.tar.gz.

File metadata

  • Download URL: joeflow-1.2.0.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0

File hashes

Hashes for joeflow-1.2.0.tar.gz
Algorithm Hash digest
SHA256 d44b53530f8ce08c2a830fdc1dbed89bce19ac97c7830e72f50fce98d6864537
MD5 6f5a900ec04a825b7a2c89c10045526c
BLAKE2b-256 65c2979ebaed153555ecfe2788fb7544f1df370a931fc8527464482818a7232f

See more details on using hashes here.

File details

Details for the file joeflow-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: joeflow-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 22.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0

File hashes

Hashes for joeflow-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6504fbab657d206aff994c4145abc875ffb28b7feea057dec6368a884cfead5e
MD5 55ae75bf10f45488376a7453e292fb6f
BLAKE2b-256 5be1bfc3ca7e5dc944db448cac7482d2df6aae4a5e2ce3d4ab51605aa6a6c6f8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page