Skip to main content

Generate realistic synthetic process event logs for testing and developing process mining software

Project description

ProcessLog

Generate realistic synthetic event logs for building and testing process-mining software.

PyPI Python 3.10+ license: MIT

ProcessLog turns a small YAML description of a process into a realistic event log — seeded and reproducible, with resource pools, working calendars, probabilistic variants, and custom attributes — and exports it as CSV, NDJSON, Parquet, or IEEE XES. Every format imports straight into PM4Py, no reshaping.

It's the data source for when you're developing a process-mining tool and don't have (or can't share) real logs.

What it is

   process definition          ProcessLog              event log
       (YAML)        ──────▶   generate, seeded   ──▶  CSV · NDJSON · Parquet · XES
                                                        PM4Py-ready · IEEE XES 1849-2023
  • Standards-clean output — CSV, NDJSON, Parquet, and XES, all directly importable into PM4Py; XES is IEEE 1849-2023 compliant with proper namespaces.
  • Realistic dynamics — resource pools with speed/consistency, working calendars (business hours, weekends, holidays), probabilistic branching into named process variants, and domain attributes (cost, priority, region, …).
  • Reproducible — a seed pins the entire run, so regression fixtures stay byte-stable.
  • Configured, not coded — one self-documenting YAML file describes the whole process.

Pairs with mining-lib — the logs you generate here render directly in it, an embeddable browser viewer for interactive Directly-Follows Graphs.

Example

A few rows of a generated CSV — the standard XES column names, ready for PM4Py:

case:concept:name,concept:name,time:timestamp,org:resource,lifecycle:transition
case_0001,submitted,2024-01-02 09:00:00-05:00,,complete
case_0001,intake_validation,2024-01-02 10:30:00-05:00,clerk_002,complete
case_0001,review_in_progress,2024-01-03 09:15:00-05:00,reviewer_001,complete
case_0001,approved,2024-01-05 14:20:00-05:00,reviewer_001,complete

Drop that log into mining-lib and you get an interactive process map:

A ProcessLog-generated log rendered as an interactive Directly-Follows Graph in mining-lib.

How to use

pip install processlog          # add [xes] for XES export: pip install "processlog[xes]"

Generate a log from a config — the CLI is the quickest path:

processlog generate -c configs/process_config.yaml -n 1000   # 1000 cases, all formats
processlog validate -c configs/process_config.yaml           # check a config
processlog info     -c configs/process_config.yaml           # summarise the process

Or from Python:

from processlog import load_config, generate_log, export_csv

config = load_config("configs/process_config.yaml")
df = generate_log(config, seed=42, num_cases=1000)
export_csv(df, "events.csv")

The full CLI, Python API, config schema, and output format live in docs/USAGE.md.

Develop

git clone https://github.com/crlsrmrlsz/processlog.git
cd processlog
python3 -m venv venv && source venv/bin/activate
pip install -e ".[dev]"
pytest

License

MIT — see LICENSE.

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

processlog-1.2.0.tar.gz (27.6 kB view details)

Uploaded Source

Built Distribution

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

processlog-1.2.0-py3-none-any.whl (31.1 kB view details)

Uploaded Python 3

File details

Details for the file processlog-1.2.0.tar.gz.

File metadata

  • Download URL: processlog-1.2.0.tar.gz
  • Upload date:
  • Size: 27.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for processlog-1.2.0.tar.gz
Algorithm Hash digest
SHA256 4fb4ddd0c983f99d5d6174971df4faab081c3f076d4e7b39c524db59b8656e92
MD5 816b556a0869eb3bc7cdffdf0ffa5aa7
BLAKE2b-256 48ccd9a4ac3c78b6a9b8d6c482ecdaf96be7cead54c27771b65160cd51cb2bce

See more details on using hashes here.

Provenance

The following attestation bundles were made for processlog-1.2.0.tar.gz:

Publisher: release.yml on crlsrmrlsz/processlog

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

File details

Details for the file processlog-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: processlog-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 31.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for processlog-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8956cc65d6735254f6d874b65051ca5d3a5f0622fc17f0938e6f7b67e353f672
MD5 f4a8e1754d686a7f773c2641679bca1a
BLAKE2b-256 b8c31c55101c169935f46d3c0f651ea88313497aa4579b5f05fbc0cc7d7b7064

See more details on using hashes here.

Provenance

The following attestation bundles were made for processlog-1.2.0-py3-none-any.whl:

Publisher: release.yml on crlsrmrlsz/processlog

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