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.3.0.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

joeflow-1.3.0-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: joeflow-1.3.0.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for joeflow-1.3.0.tar.gz
Algorithm Hash digest
SHA256 83427c3aa567ddba135b7a1daaf660662d22e6f0fc1fe21896ae99232f53b4e9
MD5 96666c4021db766591bad3d6f3e9f1f2
BLAKE2b-256 386883f00c364aab7ea104569a0ae263784199c7d6eafb7556f8bcab9625c132

See more details on using hashes here.

File details

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

File metadata

  • Download URL: joeflow-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 22.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for joeflow-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0e0e5c332da1bb1b0606ffd166504de412b8898d90dfee179d42a89e87ee11e8
MD5 6116d0bca79b1963b3d81e8e5a657977
BLAKE2b-256 3bb4b8fe3b74c23c6f363f5cbc70a1b9709e16513ed84a3c0b2e5dd9324d375f

See more details on using hashes here.

Supported by

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