{"id":47875289,"url":"https://github.com/callowayproject/pybpmn-parser","last_synced_at":"2026-04-04T01:11:51.014Z","repository":{"id":325105368,"uuid":"1099854438","full_name":"callowayproject/pybpmn-parser","owner":"callowayproject","description":"A Python library for parsing and validating BPMN 2.0 XML into typed Python objects.","archived":false,"fork":false,"pushed_at":"2026-03-23T19:50:51.000Z","size":6163,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-24T17:56:40.848Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://callowayproject.github.io/pybpmn-parser/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/callowayproject.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-19T14:25:32.000Z","updated_at":"2026-01-24T15:31:13.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/callowayproject/pybpmn-parser","commit_stats":null,"previous_names":["callowayproject/pybpmn-parser"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/callowayproject/pybpmn-parser","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/callowayproject%2Fpybpmn-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/callowayproject%2Fpybpmn-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/callowayproject%2Fpybpmn-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/callowayproject%2Fpybpmn-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/callowayproject","download_url":"https://codeload.github.com/callowayproject/pybpmn-parser/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/callowayproject%2Fpybpmn-parser/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31383780,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-03T23:20:52.058Z","status":"ssl_error","status_checked_at":"2026-04-03T23:20:51.675Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-04T01:11:49.538Z","updated_at":"2026-04-04T01:11:51.004Z","avatar_url":"https://github.com/callowayproject.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PyBPMN Parser\n\nA Python library for parsing and validating BPMN 2.0 XML into typed Python objects.\nIt provides a small, focused API for loading BPMN files, schema validation, and supports vendor-specific extensions.\n\nLinks:\n- Source: https://github.com/callowayproject/pybpmn-parser\n- Docs (MkDocs site): https://callowayproject.github.io/pybpmn_parser\n- Changelog: ./CHANGELOG.md\n- License: ./LICENSE\n\n## Overview\n\nPyBPMN Parser transforms BPMN XML documents into structured Python objects so you can analyze, traverse, and transform models programmatically.\n\n## Key features\n\n- Type-safe parsing to Python models\n- Schema validation against BPMN 2.0\n- Vendor extension support via [bpmn.io's Moddle extension mechanism](https://github.com/bpmn-io/bpmn-js-example-model-extension)\n- Simple API: parse strings or files\n\n## Example\n\n```python\nfrom pathlib import Path\nfrom pybpmn_parser.parse import Parser\n\n# Create a parser instance\nparser = Parser()\n\n# Parse a BPMN file\ndefinitions = parser.parse_file(Path(\"my_process.bpmn\"))\n\n# Access processes, elements, etc.\nfor process in definitions.processes:\n    print(process.id)\n```\n\n## Requirements\n\n- Python 3.12 or newer\n- uv (recommended) or pip/venv\n\n\n## Installation and Setup\n\nUsing uv (recommended):\n\n```bash\nuv add pybpmn-parser\n```\n\nUsing pip/venv (runtime only):\n```bash\npip install pybpmn-parser\n```\n\n## How to Use\n\nParse from a string:\n```python\nfrom pybpmn_parser.parse import Parser\n\nxml = \"\"\"\u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e\n\u003cdefinitions xmlns=\"http://www.omg.org/spec/BPMN/20100524/MODEL\" targetNamespace=\"http://bpmn.io/schema/bpmn\"\u003e\n  \u003cprocess id=\"Process_1\" /\u003e\n\u003c/definitions\u003e\n\"\"\"\n\nparser = Parser()\ndefs = parser.parse_string(xml)\n```\n\nParse from a file path:\n```python\nfrom pathlib import Path\nfrom pybpmn_parser.parse import Parser\n\nparser = Parser()\ndefs = parser.parse_file(Path(\"./path/to/diagram.bpmn\"))\n```\n\nValidation errors raise pybpmn_parser.validator.ValidationError with a human-readable message. See tests for examples of error messages.\n\n## Vendor Extensions (Plugins)\n\nThere is built-in support for:\n\n- Camunda extensions (https://github.com/camunda/camunda-bpmn-moddle)\n- Zeebe extensions (https://github.com/camunda/zeebe-bpmn-moddle)\n- Activiti extensions (https://github.com/igdianov/activiti-bpmn-moddle)\n\nTo use a custom extension, pass the Moddle definition file path to the parser:\n\n```python\nfrom pathlib import Path\nfrom pybpmn_parser.parse import Parser\n\ncustom_extension_path = Path(\"./path/to/custom_extension.json\")\nparser = Parser(moddle_extensions=[custom_extension_path])\n```\n\n\n## Scripts and Common Commands\n\nWith uv:\n- Run tests: `uv run pytest`\n- Run tests with quick output: `uv run pytest -q`\n- Coverage (HTML report is configured via pytest addopts): `uv run pytest` then open ./htmlcov/index.html\n- Lint (Ruff): `uv run ruff check .`\n- Format (Black via Ruff): `uv run ruff format .` or `uv run black .`\n- Type stubs/docs (serve): `uv run mkdocs serve`\n- Build docs: `uv run mkdocs build`\n\nWith pip/venv:\n- Run tests: `pytest`\n- Lint: `ruff check .`\n- Format: `ruff format .` or `black .`\n- Docs: `mkdocs serve` / `mkdocs build`\n\nNote: pip doesn’t understand pyproject \"dependency-groups\"; prefer uv for installing dev/test/docs dependencies.\n\n## Tests\n\nThe repository uses pytest and pytest-cov. Configuration is in pyproject.toml ([tool.pytest.ini_options]).\n\nRun the test suite:\n\n```bash\nuv run pytest\n```\n\n## License\n\nBSD 3-Clause License. See LICENSE for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcallowayproject%2Fpybpmn-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcallowayproject%2Fpybpmn-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcallowayproject%2Fpybpmn-parser/lists"}