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

Project details


Download files

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

Source Distribution

joeflow-2.0.1.tar.gz (20.0 kB view details)

Uploaded Source

Built Distribution

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

joeflow-2.0.1-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: joeflow-2.0.1.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for joeflow-2.0.1.tar.gz
Algorithm Hash digest
SHA256 6aa748dc07860a79a8ed026fe7bb1a6ec56634d77261ed0d59d267896b939efc
MD5 ef3bec67fa889e628001885b03c573e7
BLAKE2b-256 47604ad04e51f1c1deab5eb9372d537d2438a31a87cd5cbeb12a4be7151f4ff6

See more details on using hashes here.

Provenance

The following attestation bundles were made for joeflow-2.0.1.tar.gz:

Publisher: release.yml on codingjoe/joeflow

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: joeflow-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 24.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for joeflow-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a3f3771335748a4c41b7a1b20a7b2679dffd20d7960767680ff229b027fce6a2
MD5 cf0e150b50a955e3b82c91299bd3bc14
BLAKE2b-256 f8d5fdfe7785abf4eb7e29aa8aed3f8c655587d58fa45f859e31cb185bb1e2aa

See more details on using hashes here.

Provenance

The following attestation bundles were made for joeflow-2.0.1-py3-none-any.whl:

Publisher: release.yml on codingjoe/joeflow

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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