apm4py 0.1.10

apm4py is a Python API for Appian Process Mining (APM)

apm4py

apm4py is Python API for Appian Process Mining. It focuses on resource management, but provides methods that can be used to access the processed data as well.

This package is still in initial development state. Anything may change at any time. The public API should not be considered stable.

Installation

You can install apm4py directly from PyPi with e.g.

$ pip install apm4py

How to get started

To connect with an api at e.g. 'https://cloud-backend.lanalabs.com', first create an API with

from apm4py import create_api

api = create_api('https', 'cloud-backend.lanalabs.com', API_KEY)

Using the Command Line

Command line currently only supports uploading event logs. Four files for the event log have to be in one folder and follow the convention:

• event log CSV has "event" in the file name
• case attribute CSV has "case" in the file name
• event log semantics json have "event" in the file name
• case attribute log semantics json have "case" in the file name

See ./tests/data/incident_management as an example.

To install the CLI globally, use pipx:

pipx install apm4py
apm upload --name "Incident Management" tests/data/incident_management
apm list-logs

It will prompt you for host settings on the first run and also supports having multiple profiles with different hosts. Similar as the aws-cli. Profiles are saved in ~/.apm/.

Building and installing from source

poetry install
poetry build
pip install /dist/apm4py-0.X.Y-py3-none-any.whl

How to contribute

See the details in CONTRIBUTING.md.

License

Apache License 2.0