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.2.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.2-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for joeflow-1.2.2.tar.gz
Algorithm Hash digest
SHA256 e8f0495aa1d5821adc26cf57498b724b3244ca196bf210b6f5109d5ce97d3ce5
MD5 6753552eea4575b17c048fbbf4702b5e
BLAKE2b-256 5a664076c5f36a9df017c80c4bba3b7196b3c5f9e20d53a0a4918a7db7b6d31a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for joeflow-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d93db2dc9d81164afc09bbf1785a640edaac611470d64ad862e9e8a86df315df
MD5 ce46501d7920a19e511bf25defcd00e3
BLAKE2b-256 d0780d42f83d16101890e0bbc5fe174eaac843aa4e0d64fe71bcbe07dbe035d4

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