Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

pur(jo)

pur(jo) (/ˈpurjo/) is an experimental command line tool for orchestrating Robot Framework test or task suites with the Operaton BPM engine. It long-polls external service tasks from the Operaton engine, executes mapped Robot Framework test and task suites with the uv Python environment manager, and finally reports the results or errors back to the engine.

CLI

 Usage: pur [OPTIONS] COMMAND [ARGS]...

 pur(jo) is a tool for managing and serving robot packages.

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.      │
│ --show-completion             Show completion for the current shell, to copy │
│                               it or customize the installation.              │
│ --help                        Show this message and exit.                    │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ serve     Serve robot.zip packages (or directories) as BPMN service tasks.   │
│ init      Initialize a new robot package into the current directory.         │
│ wrap      Wrap the current directory into a robot.zip package.               │
│ run       Deploy process resources to BPM engine and start a new instance.   │
│ operaton  BPM engine operations as distinct sub commands (also as "bpm").    │
╰──────────────────────────────────────────────────────────────────────────────╯
 Usage: pur serve [OPTIONS] {robots}...

 Serve robot.zip packages (or directories) as BPMN service tasks.

╭─ Arguments ──────────────────────────────────────────────────────────────────────╮
│ *    robots      <path>  [required]                                              │
╰──────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────╮
│ --base-url             <str>                  [env var: ENGINE_REST_BASE_URL]    │
│                                               [default:                          │
│                                               http://localhost:8080/engine-rest] │
│ --authorization        <str>                  [env var:                          │
│                                               ENGINE_REST_AUTHORIZATION]         │
│ --secrets              <str>                  [env var: TASKS_SECRETS_PROFILE]   │
│ --timeout              <int>                  [env var:                          │
│                                               ENGINE_REST_TIMEOUT_SECONDS]       │
│                                               [default: 20]                      │
│ --poll-ttl             <int>                  [env var:                          │
│                                               ENGINE_REST_POLL_TTL_SECONDS]      │
│                                               [default: 10]                      │
│ --lock-ttl             <int>                  [env var:                          │
│                                               ENGINE_REST_LOCK_TTL_SECONDS]      │
│                                               [default: 30]                      │
│ --max-jobs             <int>                  [default: 1]                       │
│ --worker-id            <str>                  [env var: TASKS_WORKER_ID]         │
│                                               [default: operaton-robot-runner]   │
│ --log-level            <str>                  [env var: LOG_LEVEL]               │
│                                               [default: DEBUG]                   │
│ --on-fail              <FAIL|COMPLETE|ERROR>  [default: FAIL]                    │
│ --help                                        Show this message and exit.        │
╰──────────────────────────────────────────────────────────────────────────────────╯

Usage

Start Operaton:

$ podman run --rm -ti -p 8080:8080 operaton/operaton:latest

Create workspace:

$ mkdir hello-world
$ cd hello-world

Init project:

$ uv run --with=purjo -- pur init
Adding pyproject.toml
Adding README.md
Adding Hello.py
Adding hello.robot
Adding uv.lock
Adding Makefile
Adding hello.bpmn
Adding test_hello.robot
Adding src/hello_world/__init__.py

The generated Makefile wraps the common commands; run make help to list them.

Or init with Robot Framework task template (uses *** Tasks *** instead of *** Test Cases ***):

$ uv run --with=purjo -- pur init --task

Or add an AGENTS.md guide for LLM coding agents working on the package (not supported with --python):

$ uv run --with=purjo -- pur init --agents
...
Adding AGENTS.md

Deploy and start an example process:

$ uv run --with=purjo -- pur run hello.bpmn
Started: http://localhost:8080/operaton/app/cockpit/default/#/process-instance/36228e79-e97e-11ef-a0ec-52f4bfd829ae/runtime

Serve the project as external task worker:

$ uv run --with=purjo -- pur serve .
... | INFO | ... | Scheduling My Topic in BPMN:3622b58f-e97e-11ef-a0ec-52f4bfd829ae.
==============================================================================
Tmpdlb85Jrp
==============================================================================
Tmpdlb85Jrp.Hello
==============================================================================
My Test in Robot                                                      | PASS |
------------------------------------------------------------------------------
Tmpdlb85Jrp.Hello                                                     | PASS |
1 test, 1 passed, 0 failed
==============================================================================
Tmpdlb85Jrp                                                           | PASS |
1 test, 1 passed, 0 failed
==============================================================================
Output:  /tmp/tmp2721mpez/output.xml
Log:     /tmp/tmp2721mpez/log.html
Report:  /tmp/tmp2721mpez/report.html
... | INFO | ... | Completing My Topic in BPMN:3622b58f-e97e-11ef-a0ec-52f4bfd829ae.

The example rolls a die and fails with Bad luck on a roll below 3, to demonstrate BPMN error handling: about one run in three prints FAIL and the process continues through its error boundary event instead.

Nix builds

Private artifacts in uv.lock are fetched by Nix during evaluation. Set NETRC to a readable netrc file; the Makefile passes it to Nix as netrc-file. For direct Nix commands, use the same Nix option:

$ nix --option netrc-file "$NETRC" build .#image

The credentials are used by the evaluating Nix client and are not exposed to sandboxed build steps. Do not add the netrc file to extra-sandbox-paths.

More information

Metadata

Release files for purjo 1.0rc3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for purjo 1.0rc3
File Size Uploaded Provenance Actions
purjo-1.0rc3.tar.gz 42.2 kB With provenance Details for purjo-1.0rc3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for purjo 1.0rc3
File Interpreter ABI Platform Actions
purjo-1.0rc3-py3-none-any.whl Python 3 none any Details for purjo-1.0rc3-py3-none-any.whl

Total release size: 93.7 kB

Release files / purjo-1.0rc3.tar.gz

Download URL purjo-1.0rc3.tar.gz
Size 42.2 kB
Tags Source
SHA-256 checksum
How to use checksums
4a29dcf1be8f9e3c412b6565b1faf1221b2fd34d6a1d3e9b9bd3a7d688d8099d
BLAKE2b-256 checksum
How to use checksums
1b1f848d840ba18f2cb2c8d8d21dc98e31ccdaafc917588b934da39aabbe39c3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Release files / purjo-1.0rc3-py3-none-any.whl

Download URL purjo-1.0rc3-py3-none-any.whl
Size 51.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6a7d156ef090abad9a37c8e9b97146638c37ba4c60ab428393cc3d587a3a5483
BLAKE2b-256 checksum
How to use checksums
cf5e95247f3c0b58a300fb99bb0ac5ca52a03417cfe737bfea87441af3748c70
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Security for purjo 1.0rc3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for purjo-1.0rc3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page