Installation¶

The Workflow package is available on PyPI and can be installed using pip or added to a Poetry project. Additionally, the Workflow package is available as a container image on Docker Hub.

pip¶

To install the Workflow package from PyPI, run:

Bash

pip install workflow.core

Add to Poetry Project¶

To add the Workflow package to your Poetry project, run:

Bash

poetry add workflow.core

Get Source Code¶

To get the source code of the Workflow package, run:

Bash

git clone https://github.com/chimefrb/workflow.git
cd workflow
poetry install

Container Image¶

To setup the Workflow in a container image, it is recommended to set the workflow set workspace command during the container build process. For example, in a Dockerfile:

Docker

FROM python:3.10-slim-buster
RUN set -ex \
    pip install workflow.core && \
    workflow workspace set development

Alternatively, you can use the workflow container image from Docker Hub:

Bash

docker pull chimefrb/workflow

and base your container image on it:

Docker

FROM chimefrb/workflow as base
RUN set -ex \
    pip install your-package