bpmn-io 0.1.0__tar.gz

bpmn_io-0.1.0/.gitignore

@@ -0,0 +1,24 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+dist/
+build/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.hypothesis/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+# upstream reference checkouts (fetched, never committed)
+.upstream/
+# editors / OS
+.idea/
+.vscode/
+.DS_Store
+
+# Node oracle
+tests/oracle/node_modules/

bpmn_io-0.1.0/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
+[Semantic Versioning](https://semver.org/).
+
+## [0.1.0] - 2026-09-24
+
+### Added
+
+- Repository scaffold: uv project, ruff, mypy strict, pytest, pre-commit, GitHub Actions CI,
+  tag-driven PyPI release through Trusted Publishing, Dependabot.
+- Vendored upstream descriptors, fixtures and test-suites with a sha256 provenance ledger
+  (`UPSTREAM.toml`, `UPSTREAM.lock`, `scripts/sync_upstream.py`).
+- `scripts/port_coverage.py`: upstream test-suite port coverage report and CI gate.
+- Upstream Node oracle pins (`tests/oracle`).
+- Pure-Python port of `moddle`, `moddle-xml`, `bpmn-moddle` (six descriptors) and
+  `bpmn-auto-layout`: read, check, build, lay out and write BPMN 2.0 XML with no
+  runtime dependency.
+- Typed creation surface: generated `bpmn_moddle/types.pyi` (`create` overloads on
+  descriptor literals, `is_a` narrowing), verified with `stubtest` + `assert_type`.
+- `bpmn-io` CLI: `check | roundtrip | layout <file> [--json]` with stable exit codes.

bpmn_io-0.1.0/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Fabien Antoine
+Copyright (c) 2014-2026 camunda Services GmbH (upstream bpmn.io libraries transposed here;
+see THIRD_PARTY_NOTICES.md)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

bpmn_io-0.1.0/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.5
+Name: bpmn-io
+Version: 0.1.0
+Summary: Pure-Python port of bpmn.io bpmn-moddle and bpmn-auto-layout: read, check, build, lay out and write BPMN 2.0 XML
+Project-URL: Homepage, https://github.com/rhanka/bpmn-io-py
+Project-URL: Repository, https://github.com/rhanka/bpmn-io-py
+Project-URL: Issues, https://github.com/rhanka/bpmn-io-py/issues
+Project-URL: Changelog, https://github.com/rhanka/bpmn-io-py/blob/main/CHANGELOG.md
+Project-URL: Upstream: bpmn-moddle, https://github.com/bpmn-io/bpmn-moddle
+Project-URL: Upstream: bpmn-auto-layout, https://github.com/bpmn-io/bpmn-auto-layout
+Author: Fabien Antoine
+License-Expression: MIT
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.md
+Keywords: agents,bpmn,bpmn-auto-layout,bpmn-io,bpmn-moddle,bpmn2,moddle,process,workflow,xml
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: Markup :: XML
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# bpmn-io
+
+**bpmn.io's `bpmn-moddle` and `bpmn-auto-layout`, transposed to pure Python.**
+
+Read, check, build, lay out and write BPMN 2.0 XML from Python, with the exact object model and
+semantics of the reference JavaScript implementation, and no runtime dependency.
+
+> Status: the full port is implemented (moddle, moddle-xml, bpmn-moddle, bpmn-auto-layout)
+> with byte-identical conformance gates; release 0.1.0 is in preparation. Nothing is published
+> on PyPI yet.
+>
+> bpmn-io is an independent project, not affiliated with bpmn.io or Camunda.
+
+## Why this exists
+
+BPMN is a natural target for AI agents written in Python (Google ADK, LangGraph, plain SDK
+agents, …): an agent can draft a process, check it, lay it out and hand a valid `.bpmn` file to a
+human or to an engine. Until now the only faithful implementation of the BPMN 2.0 meta-model
+(`bpmn-moddle`) and of automatic diagram layout (`bpmn-auto-layout`) lived in JavaScript, so a
+Python agent had to shell out to Node or skip validation altogether.
+
+bpmn-io removes that gap: a 100 % mapped Python port, so the objects, the warnings and the XML you
+get are the ones bpmn-js, Camunda Modeler and the bpmn.io toolchain produce and expect.
+
+## Design principles
+
+- **Literal transposition.** Algorithms and test-suites of `moddle`, `moddle-xml`, `bpmn-moddle`
+  and `bpmn-auto-layout` are ported one-to-one, at the pinned upstream versions listed in
+  [`UPSTREAM.toml`](UPSTREAM.toml). Every upstream test case must be claimed by a Python test
+  (`scripts/port_coverage.py`, enforced in CI).
+- **Same descriptors.** The BPMN 2.0, DI, DC and bioc moddle descriptors are vendored verbatim
+  (sha256-pinned in `UPSTREAM.lock`), so `$type` names, properties and serialization rules are
+  identical.
+- **Differential oracle.** CI also runs the upstream JavaScript packages through Node and compares
+  canonical dumps and emitted XML with the Python port (`tests/oracle/`).
+- **Zero runtime dependency.** The lenient SAX parser (`saxen`) is transposed too, so parsing
+  behaviour, warnings and error positions match upstream exactly.
+- **MIT, attributed.** See [`LICENSE`](LICENSE) and
+  [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md).
+
+## Usage
+
+```python
+from bpmn_io import BpmnModdle, check, layout_process
+
+moddle = BpmnModdle()
+
+# read
+result = moddle.from_xml(xml)  # ParseResult(root_element, references, warnings, elements_by_id)
+definitions = result.root_element
+
+# check (L0 integrity: warnings, unresolved references, unknown attributes)
+report = check(xml)
+assert report.ok, report.errors
+
+# build
+task = moddle.create("bpmn:Task", {"name": "Review"})
+definitions.get("rootElements")[0].get("flowElements").append(task)
+
+# lay out (generates DI for diagrams without one)
+laid_out = layout_process(xml)
+
+# write
+out = moddle.to_xml(definitions, {"format": True})
+print(out.xml)
+```
+
+```bash
+bpmn-io check process.bpmn            # exit 0 when clean, 1 on errors
+bpmn-io check process.bpmn --json     # {"ok": true, "errors": [], "warnings": [], ...}
+bpmn-io roundtrip process.bpmn        # parse + serialize back to stdout
+bpmn-io layout process.bpmn           # automatic DI layout to stdout
+```
+
+## API
+
+| Name | Module | Contract |
+|---|---|---|
+| `BpmnModdle` | `bpmn_io.bpmn_moddle` | default model (six descriptors), lax `from_xml`, `to_xml` |
+| `create_moddle` | `bpmn_io.bpmn_moddle` | `BpmnModdle` plus additional descriptor packages |
+| `check` / `Report` | `bpmn_io.check` | L0 integrity: warnings, unresolved references, unknown attributes |
+| `layout_process` / `Layouter` | `bpmn_io.auto_layout` | automatic DI layout; `LayoutError` on failure |
+| `is_a` | `bpmn_io.bpmn_moddle.types` | `TypeGuard` narrowing on descriptor literal types |
+| `ParseResult` / `ParseError` | `bpmn_io.moddle_xml` | read result / failure |
+| `SerializationResult` | `bpmn_io.bpmn_moddle` | `to_xml` result (`xml`, `warnings`) |
+| `DESCRIPTOR_NAMES` / `load_descriptor` | `bpmn_io.descriptors` | vendored descriptor registry |
+| `UPSTREAM_VERSIONS` | `bpmn_io.upstream` | pinned upstream versions |
+
+## Development
+
+```bash
+uv sync                      # Python 3.11+, all dependency groups
+uv run pytest                # Python test-suite
+uv run ruff check . && uv run ruff format --check . && uv run mypy
+uv run python scripts/sync_upstream.py --check     # vendored upstream files untouched
+uv run python scripts/port_coverage.py             # upstream test-suite port status
+(cd tests/oracle && npm ci --ignore-scripts) && uv run pytest -m oracle   # Node differential tests
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the porting workflow and the release process.
+
+## Upstream versions
+
+| Upstream | Version |
+|---|---|
+| saxen | 11.2.0 |
+| min-dash | 5.1.0 |
+| moddle | 8.2.1 |
+| moddle-xml | 12.3.1 |
+| bpmn-moddle | 10.3.1 |
+| bpmn-in-color-moddle | 0.2.0 |
+| bpmn-auto-layout | 1.3.0 |

bpmn_io-0.1.0/README.md

@@ -0,0 +1,112 @@
+# bpmn-io
+
+**bpmn.io's `bpmn-moddle` and `bpmn-auto-layout`, transposed to pure Python.**
+
+Read, check, build, lay out and write BPMN 2.0 XML from Python, with the exact object model and
+semantics of the reference JavaScript implementation, and no runtime dependency.
+
+> Status: the full port is implemented (moddle, moddle-xml, bpmn-moddle, bpmn-auto-layout)
+> with byte-identical conformance gates; release 0.1.0 is in preparation. Nothing is published
+> on PyPI yet.
+>
+> bpmn-io is an independent project, not affiliated with bpmn.io or Camunda.
+
+## Why this exists
+
+BPMN is a natural target for AI agents written in Python (Google ADK, LangGraph, plain SDK
+agents, …): an agent can draft a process, check it, lay it out and hand a valid `.bpmn` file to a
+human or to an engine. Until now the only faithful implementation of the BPMN 2.0 meta-model
+(`bpmn-moddle`) and of automatic diagram layout (`bpmn-auto-layout`) lived in JavaScript, so a
+Python agent had to shell out to Node or skip validation altogether.
+
+bpmn-io removes that gap: a 100 % mapped Python port, so the objects, the warnings and the XML you
+get are the ones bpmn-js, Camunda Modeler and the bpmn.io toolchain produce and expect.
+
+## Design principles
+
+- **Literal transposition.** Algorithms and test-suites of `moddle`, `moddle-xml`, `bpmn-moddle`
+  and `bpmn-auto-layout` are ported one-to-one, at the pinned upstream versions listed in
+  [`UPSTREAM.toml`](UPSTREAM.toml). Every upstream test case must be claimed by a Python test
+  (`scripts/port_coverage.py`, enforced in CI).
+- **Same descriptors.** The BPMN 2.0, DI, DC and bioc moddle descriptors are vendored verbatim
+  (sha256-pinned in `UPSTREAM.lock`), so `$type` names, properties and serialization rules are
+  identical.
+- **Differential oracle.** CI also runs the upstream JavaScript packages through Node and compares
+  canonical dumps and emitted XML with the Python port (`tests/oracle/`).
+- **Zero runtime dependency.** The lenient SAX parser (`saxen`) is transposed too, so parsing
+  behaviour, warnings and error positions match upstream exactly.
+- **MIT, attributed.** See [`LICENSE`](LICENSE) and
+  [`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md).
+
+## Usage
+
+```python
+from bpmn_io import BpmnModdle, check, layout_process
+
+moddle = BpmnModdle()
+
+# read
+result = moddle.from_xml(xml)  # ParseResult(root_element, references, warnings, elements_by_id)
+definitions = result.root_element
+
+# check (L0 integrity: warnings, unresolved references, unknown attributes)
+report = check(xml)
+assert report.ok, report.errors
+
+# build
+task = moddle.create("bpmn:Task", {"name": "Review"})
+definitions.get("rootElements")[0].get("flowElements").append(task)
+
+# lay out (generates DI for diagrams without one)
+laid_out = layout_process(xml)
+
+# write
+out = moddle.to_xml(definitions, {"format": True})
+print(out.xml)
+```
+
+```bash
+bpmn-io check process.bpmn            # exit 0 when clean, 1 on errors
+bpmn-io check process.bpmn --json     # {"ok": true, "errors": [], "warnings": [], ...}
+bpmn-io roundtrip process.bpmn        # parse + serialize back to stdout
+bpmn-io layout process.bpmn           # automatic DI layout to stdout
+```
+
+## API
+
+| Name | Module | Contract |
+|---|---|---|
+| `BpmnModdle` | `bpmn_io.bpmn_moddle` | default model (six descriptors), lax `from_xml`, `to_xml` |
+| `create_moddle` | `bpmn_io.bpmn_moddle` | `BpmnModdle` plus additional descriptor packages |
+| `check` / `Report` | `bpmn_io.check` | L0 integrity: warnings, unresolved references, unknown attributes |
+| `layout_process` / `Layouter` | `bpmn_io.auto_layout` | automatic DI layout; `LayoutError` on failure |
+| `is_a` | `bpmn_io.bpmn_moddle.types` | `TypeGuard` narrowing on descriptor literal types |
+| `ParseResult` / `ParseError` | `bpmn_io.moddle_xml` | read result / failure |
+| `SerializationResult` | `bpmn_io.bpmn_moddle` | `to_xml` result (`xml`, `warnings`) |
+| `DESCRIPTOR_NAMES` / `load_descriptor` | `bpmn_io.descriptors` | vendored descriptor registry |
+| `UPSTREAM_VERSIONS` | `bpmn_io.upstream` | pinned upstream versions |
+
+## Development
+
+```bash
+uv sync                      # Python 3.11+, all dependency groups
+uv run pytest                # Python test-suite
+uv run ruff check . && uv run ruff format --check . && uv run mypy
+uv run python scripts/sync_upstream.py --check     # vendored upstream files untouched
+uv run python scripts/port_coverage.py             # upstream test-suite port status
+(cd tests/oracle && npm ci --ignore-scripts) && uv run pytest -m oracle   # Node differential tests
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the porting workflow and the release process.
+
+## Upstream versions
+
+| Upstream | Version |
+|---|---|
+| saxen | 11.2.0 |
+| min-dash | 5.1.0 |
+| moddle | 8.2.1 |
+| moddle-xml | 12.3.1 |
+| bpmn-moddle | 10.3.1 |
+| bpmn-in-color-moddle | 0.2.0 |
+| bpmn-auto-layout | 1.3.0 |

bpmn_io-0.1.0/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,50 @@
+# Third-party notices
+
+bpmn-io is a literal transposition to Python of the following bpmn.io libraries. Their algorithms,
+descriptors, test fixtures and test-suites are reproduced or translated here under the terms of the
+MIT License, with the original copyright notice preserved. bpmn-io is an independent project and is
+**not affiliated with, endorsed by, or supported by bpmn.io or Camunda**.
+
+| Upstream project | Version | Copyright | License | What is transposed |
+|---|---|---|---|---|
+| [saxen](https://github.com/nikku/saxen) | 11.2.0 | 2012 Vopilovskii Konstantin; 2017-present Nico Rehwaldt | MIT | lenient SAX XML parser, test-suite |
+| [min-dash](https://github.com/bpmn-io/min-dash) | 5.1.0 | 2017-present camunda Services GmbH | MIT | the utility helpers used by the libraries below, their tests |
+| [moddle](https://github.com/bpmn-io/moddle) | 8.2.1 | 2014-present Camunda Services GmbH | MIT | meta-model runtime (registry, factory, properties), moddle.json schema, test-suite |
+| [moddle-xml](https://github.com/bpmn-io/moddle-xml) | 12.3.1 | 2014-present Camunda Services GmbH | MIT | XML reader/writer, test-suite and fixtures |
+| [bpmn-moddle](https://github.com/bpmn-io/bpmn-moddle) | 10.3.1 | 2014 camunda Services GmbH | MIT | BPMN 2.0 / DI / DC / bioc descriptors (`src/bpmn_io/resources`), wiring, test-suite and fixtures |
+| [bpmn-in-color-moddle](https://github.com/bpmn-io/bpmn-in-color-moddle) | 0.2.0 | bpmn.io contributors | MIT | BPMN in Color descriptor (`src/bpmn_io/resources/color`) |
+| [bpmn-auto-layout](https://github.com/bpmn-io/bpmn-auto-layout) | 1.3.0 | bpmn.io contributors (package.json declares MIT; no LICENSE file at the pinned tag, status unverified) | MIT | layout algorithm, test-suite, fixtures and snapshots |
+
+Exact tags, commits and per-file sha256 digests of every vendored file are recorded in
+`UPSTREAM.toml` and `UPSTREAM.lock`.
+
+The BPMN 2.0 descriptors were generated upstream from the OMG BPMN 2.0 specification metamodel
+(CMOF). The OMG XSD schema files are **not** redistributed by this package.
+
+## Upstream license text
+
+The same MIT text applies to every project above, with the copyright holder(s) listed in the table.
+
+```
+The MIT License (MIT)
+
+Copyright (c) <holder(s) as listed above>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+```