Installation¶

PyBPMN Parser requires Python 3.12 or higher. This guide covers different installation methods.

Requirements¶

Python 3.12+
pip (usually included with Python) or uv

Installing from PyPI¶

The recommended way to install PyBPMN Parser is from PyPI using pip:

pip install pybpmn-parser

This installs the latest stable release with all required dependencies.

Installing with uv¶

If you use uv for dependency management:

uv add pybpmn-parser

Or in a uv project:

uv pip install pybpmn-parser

Installing from Source¶

To install the development version from the GitHub repository:

# Clone the repository
git clone https://github.com/callowayproject/pybpmn-parser.git
cd pybpmn-parser

# Install in development mode
pip install -e .

Or with uv:

git clone https://github.com/callowayproject/pybpmn-parser.git
cd pybpmn-parser
uv pip install -e .

Verifying Installation¶

After installation, verify that PyBPMN Parser is installed correctly:

from pybpmn_parser.parse import Parser

# Test with minimal BPMN XML
xml = """<?xml version="1.0" encoding="UTF-8"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL"
             targetNamespace="http://bpmn.io/schema/bpmn">
    <process id="Process_1" />
</definitions>"""

parser = Parser()
definitions = parser.parse_string(xml)
print(f"Successfully parsed! Found {len(definitions.processes)} process(es)")

Expected output:

Successfully parsed! Found 1 process(es)

Optional Dependencies¶

PyBPMN Parser has minimal required dependencies (lxml for XML parsing). All core functionality works out of the box.

Troubleshooting¶

lxml Installation Issues¶

If you encounter issues installing lxml (especially on Windows):

# Install lxml separately first
pip install lxml

# Then install pybpmn-parser
pip install pybpmn-parser

Python Version Issues¶

Ensure you’re using Python 3.12 or higher:

python --version

If you have multiple Python versions, you may need to use python3 or a specific 3.12+ interpreter explicitly:

python3 -m pip install pybpmn-parser

Next Steps¶

Now that PyBPMN Parser is installed, continue to the Quick Start guide to learn how to use it.