Metadata-Version: 2.4
Name: pm4py_config
Version: 0.1.0
Summary: A thin configuration and convenience layer for pm4py
License: MIT
Project-URL: Homepage, https://github.com/adamburkegh/pm4py_config
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pm4py
Dynamic: license-file

# pm4py\_config

`pm4py_config` is a thin configuration and convenience function layer for
the powerful [pm4py](https://github.com/process-intelligence-solutions/pm4py)
process mining library. 

`pm4py_config` defaults to quiet output. `pm4py` default behaviour can be 
configured by using `pm4py_config.UPSTREAM_DEFAULT`.

## Usage

Use as a drop-in replacement for `import pm4py` throughout your project.

```python
import pm4py_config as pm

log = pm.read_xes("running-example.xes")
net, im, fm = pm.discover_petri_net_inductive(log)
```

To reconfigure — e.g. turn XES progress bars back on — call `load()` once,
early, before any other module imports `pm4py_config`:

```python
import pm4py_config as pm

pm.load(progress_bar=True)

log = pm.read_xes("running-example.xes")  # shows a tqdm progress bar
```

## Supported flags

See `pm4py_config.Config`'s [docstring](pm4py_config/__init__.py) for the 
authoritative, up-to-date list.


