Skip to content

Introduction

BPMN Parser, read .bpmn files as Python.

Test Tests Coverage Package version Python Versions

Documentation: https://danbailo.github.io/bpmn-parser/

Source Code: https://github.com/danbailo/bpmn-parser

BPMN Parser is a library to read and parse .bpmn files with Python. With this, you can create another things related with BPMN, such as linters, tests, validate BPMN flows, etc.

The key features are:

  • Easy to use: It's easy to use for the final users.
  • Start simple: Just import and use!
  • Support to build other applications: This library allow and helps to build another applications, such linters, tests, validators, etc.

Installation

Create and activate a virtual environment and then install BPMN Parser:

$ pip install bpmn-parser
---> 100%
Successfully installed bpmn-parser

Example

  • Create a file main.py with:
# Import BPMN Parser
from bpmn_parser import BPMNParser

# Instance it
bpmn_parser = BPMNParser('/path/to/bpmn/flow.bpmn')

# Listing service tasks
for service_task in bpmn_parser.service_task.list:
    print(service_task)

# Getting service task
print(bpmn_parser.service_task.get('Activity_139q5mt'))

Development

Using pyenv

Install the prerequisites and then install pyenv. After install and configure pyenv, just install the project using Make.

make prepare_env_pyenv

Using poetry

pip install poetry

Then, just install the project

make install

Project commands

Command Description
make install Install project as dev
make check_format Check code format
make format Format the code
make check_lint Check code lint
make lint Lint the code
make check_types Check code types
make tests Run tests
make check_all Run all checkers of project
make prepare_env_pyenv Prepare an enviroment with pyenv