transitions-reactflow 0.1.0__tar.gz

transitions_reactflow-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 transitions-reactflow contributors
+
+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.

transitions_reactflow-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+include transitions_reactflow/*.pyi
+include transitions_reactflow/py.typed

transitions_reactflow-0.1.0/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.4
+Name: transitions-reactflow
+Version: 0.1.0
+Summary: React Flow graph engine for pytransitions state machines
+Author: transitions_reactflow contributors
+License: MIT License
+        
+        Copyright (c) 2026 transitions-reactflow contributors
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/johnsonlm/transitions-reactflow
+Project-URL: Bug Reports, https://github.com/johnsonlm/transitions-reactflow/issues
+Project-URL: Source, https://github.com/johnsonlm/transitions-reactflow
+Keywords: state-machine,transitions,visualization,react-flow
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: transitions>=0.8.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: mypy>=0.950; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Requires-Dist: build>=0.10.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Dynamic: license-file
+
+# transitions_reactflow
+
+A React Flow graph engine extension for the [pytransitions](https://github.com/pytransitions/transitions) state machine library.
+
+## Features
+
+- ✅ React Flow compatible graph data
+- ✅ Hierarchical states with `children` parameter
+- ✅ Smart filtering of unused states
+- ✅ Unique edge IDs for duplicate transitions
+- ✅ Full type hints with .pyi stub files
+- ✅ Comprehensive test suite
+
+## Installation
+
+```bash
+pip install transitions-reactflow
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/johnsonlm/transitions-reactflow
+cd transitions-reactflow
+pip install -e .
+```
+
+## Quick Start
+
+```python
+from transitions_reactflow import ReactFlowMachine
+
+# Define states with hierarchy
+states = [
+    'idle',
+    {'name': 'processing', 'children': ['validating', 'payment']},
+    'completed'
+]
+
+# Define transitions
+transitions = [
+    {'trigger': 'start', 'source': 'idle', 'dest': 'processing_validating'},
+    {'trigger': 'validate', 'source': 'processing_validating', 'dest': 'processing_payment'},
+    {'trigger': 'finish', 'source': 'processing_payment', 'dest': 'completed'}
+]
+
+# Create machine and get graph data
+machine = ReactFlowMachine(states=states, transitions=transitions, initial='idle')
+graph_data = machine.get_graph()
+
+# Returns: {'nodes': [...], 'edges': [...]}
+```
+
+## Usage
+
+### With Flask Backend
+
+```python
+from flask import Flask, jsonify
+from flask_cors import CORS
+from transitions_reactflow import ReactFlowMachine
+
+app = Flask(__name__)
+CORS(app)  # Enable CORS for frontend requests
+
+machine = ReactFlowMachine(states=states, transitions=transitions, initial='idle')
+
+@app.route('/graph-data')
+def get_graph_data():
+    return jsonify(machine.get_graph())
+```
+
+### With React Frontend
+
+```javascript
+import ReactFlow from 'reactflow';
+
+function StateMachineFlow() {
+  const [data, setData] = useState(null);
+
+  useEffect(() => {
+    fetch('/graph-data').then(res => res.json()).then(setData);
+  }, []);
+
+  return data && <ReactFlow nodes={data.nodes} edges={data.edges} fitView />;
+}
+```
+
+## Hierarchical States
+
+Use `children` for nested states:
+
+```python
+states = [
+    'idle',
+    {'name': 'error', 'children': ['validation', 'payment', 'network']}
+]
+# Creates: error, error_validation, error_payment, error_network
+```
+
+**Note**: Unused parent states are automatically filtered from the graph.
+
+## API
+
+### ReactFlowMachine
+
+Extends `transitions.extensions.GraphMachine`.
+
+- `get_graph(title=None, roi_state=None)` → `{'nodes': [...], 'edges': [...]}`
+- `add_states(states)` - supports hierarchical definitions
+- All standard pytransitions methods
+
+### ReactFlowGraph
+
+Extends `transitions.extensions.diagrams_base.BaseGraph`.
+
+- `get_graph(title=None, roi_state=None)` → React Flow data
+- Standard BaseGraph methods
+
+## Graph Data Format
+
+The `get_graph()` method returns React Flow compatible data:
+
+**Nodes:**
+```python
+{
+    "id": "state_name",
+    "data": {"label": "state_name"},
+    "position": {"x": 0, "y": 0}
+}
+```
+
+**Edges:**
+```python
+{
+    "id": "e-source-target",
+    "source": "source_state",
+    "target": "target_state",
+    "label": "trigger_name"
+}
+```
+
+## Development
+
+```bash
+# Tests
+pytest tests/
+
+# Coverage
+pytest --cov=transitions_reactflow tests/
+
+# Type checking
+mypy transitions_reactflow/
+```
+
+## License
+
+MIT - see LICENSE file
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Credits
+
+Built on top of the [pytransitions](https://github.com/pytransitions/transitions) library.

transitions_reactflow-0.1.0/README.md

@@ -0,0 +1,166 @@
+# transitions_reactflow
+
+A React Flow graph engine extension for the [pytransitions](https://github.com/pytransitions/transitions) state machine library.
+
+## Features
+
+- ✅ React Flow compatible graph data
+- ✅ Hierarchical states with `children` parameter
+- ✅ Smart filtering of unused states
+- ✅ Unique edge IDs for duplicate transitions
+- ✅ Full type hints with .pyi stub files
+- ✅ Comprehensive test suite
+
+## Installation
+
+```bash
+pip install transitions-reactflow
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/johnsonlm/transitions-reactflow
+cd transitions-reactflow
+pip install -e .
+```
+
+## Quick Start
+
+```python
+from transitions_reactflow import ReactFlowMachine
+
+# Define states with hierarchy
+states = [
+    'idle',
+    {'name': 'processing', 'children': ['validating', 'payment']},
+    'completed'
+]
+
+# Define transitions
+transitions = [
+    {'trigger': 'start', 'source': 'idle', 'dest': 'processing_validating'},
+    {'trigger': 'validate', 'source': 'processing_validating', 'dest': 'processing_payment'},
+    {'trigger': 'finish', 'source': 'processing_payment', 'dest': 'completed'}
+]
+
+# Create machine and get graph data
+machine = ReactFlowMachine(states=states, transitions=transitions, initial='idle')
+graph_data = machine.get_graph()
+
+# Returns: {'nodes': [...], 'edges': [...]}
+```
+
+## Usage
+
+### With Flask Backend
+
+```python
+from flask import Flask, jsonify
+from flask_cors import CORS
+from transitions_reactflow import ReactFlowMachine
+
+app = Flask(__name__)
+CORS(app)  # Enable CORS for frontend requests
+
+machine = ReactFlowMachine(states=states, transitions=transitions, initial='idle')
+
+@app.route('/graph-data')
+def get_graph_data():
+    return jsonify(machine.get_graph())
+```
+
+### With React Frontend
+
+```javascript
+import ReactFlow from 'reactflow';
+
+function StateMachineFlow() {
+  const [data, setData] = useState(null);
+
+  useEffect(() => {
+    fetch('/graph-data').then(res => res.json()).then(setData);
+  }, []);
+
+  return data && <ReactFlow nodes={data.nodes} edges={data.edges} fitView />;
+}
+```
+
+## Hierarchical States
+
+Use `children` for nested states:
+
+```python
+states = [
+    'idle',
+    {'name': 'error', 'children': ['validation', 'payment', 'network']}
+]
+# Creates: error, error_validation, error_payment, error_network
+```
+
+**Note**: Unused parent states are automatically filtered from the graph.
+
+## API
+
+### ReactFlowMachine
+
+Extends `transitions.extensions.GraphMachine`.
+
+- `get_graph(title=None, roi_state=None)` → `{'nodes': [...], 'edges': [...]}`
+- `add_states(states)` - supports hierarchical definitions
+- All standard pytransitions methods
+
+### ReactFlowGraph
+
+Extends `transitions.extensions.diagrams_base.BaseGraph`.
+
+- `get_graph(title=None, roi_state=None)` → React Flow data
+- Standard BaseGraph methods
+
+## Graph Data Format
+
+The `get_graph()` method returns React Flow compatible data:
+
+**Nodes:**
+```python
+{
+    "id": "state_name",
+    "data": {"label": "state_name"},
+    "position": {"x": 0, "y": 0}
+}
+```
+
+**Edges:**
+```python
+{
+    "id": "e-source-target",
+    "source": "source_state",
+    "target": "target_state",
+    "label": "trigger_name"
+}
+```
+
+## Development
+
+```bash
+# Tests
+pytest tests/
+
+# Coverage
+pytest --cov=transitions_reactflow tests/
+
+# Type checking
+mypy transitions_reactflow/
+```
+
+## License
+
+MIT - see LICENSE file
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Credits
+
+Built on top of the [pytransitions](https://github.com/pytransitions/transitions) library.

transitions_reactflow-0.1.0/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "transitions-reactflow"
+version = "0.1.0"
+description = "React Flow graph engine for pytransitions state machines"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {file = "LICENSE"}
+authors = [
+    {name = "transitions_reactflow contributors"}
+]
+keywords = ["state-machine", "transitions", "visualization", "react-flow"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Scientific/Engineering :: Visualization",
+]
+dependencies = [
+    "transitions>=0.8.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=3.0.0",
+    "black>=22.0.0",
+    "mypy>=0.950",
+    "flake8>=4.0.0",
+    "build>=0.10.0",
+    "twine>=4.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/johnsonlm/transitions-reactflow"
+"Bug Reports" = "https://github.com/johnsonlm/transitions-reactflow/issues"
+"Source" = "https://github.com/johnsonlm/transitions-reactflow"
+
+[tool.setuptools]
+packages = ["transitions_reactflow"]
+
+[tool.setuptools.package-data]
+transitions_reactflow = ["*.pyi", "py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = false

transitions_reactflow-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

transitions_reactflow-0.1.0/tests/test_graph.py

@@ -0,0 +1,165 @@
+"""Tests for ReactFlowGraph class."""
+
+import pytest
+from transitions_reactflow import ReactFlowMachine
+
+
+class TestReactFlowGraph:
+    """Test cases for ReactFlowGraph."""
+
+    def test_node_structure(self):
+        """Test that nodes have the correct structure."""
+        states = ['idle', 'running']
+        transitions = [{'trigger': 'start',
+                        'source': 'idle', 'dest': 'running'}]
+
+        machine = ReactFlowMachine(
+            states=states, transitions=transitions, initial='idle')
+        graph = machine.get_graph()
+
+        # Check node structure
+        for node in graph['nodes']:
+            assert 'id' in node
+            assert 'data' in node
+            assert 'position' in node
+            assert 'label' in node['data']
+            assert 'x' in node['position']
+            assert 'y' in node['position']
+
+    def test_edge_structure(self):
+        """Test that edges have the correct structure."""
+        states = ['idle', 'running']
+        transitions = [{'trigger': 'start',
+                        'source': 'idle', 'dest': 'running'}]
+
+        machine = ReactFlowMachine(
+            states=states, transitions=transitions, initial='idle')
+        graph = machine.get_graph()
+
+        # Check edge structure
+        for edge in graph['edges']:
+            assert 'id' in edge
+            assert 'source' in edge
+            assert 'target' in edge
+            assert 'label' in edge
+
+    def test_multiple_transitions(self):
+        """Test graph with multiple transitions."""
+        states = ['idle', 'validating', 'payment', 'completed']
+        transitions = [
+            {'trigger': 'start', 'source': 'idle', 'dest': 'validating'},
+            {'trigger': 'validate', 'source': 'validating', 'dest': 'payment'},
+            {'trigger': 'pay', 'source': 'payment', 'dest': 'completed'},
+        ]
+
+        machine = ReactFlowMachine(
+            states=states, transitions=transitions, initial='idle')
+        graph = machine.get_graph()
+
+        assert len(graph['nodes']) == 4
+        assert len(graph['edges']) == 3
+
+    def test_self_transition(self):
+        """Test graph with self-transition."""
+        states = ['idle', 'running']
+        transitions = [
+            {'trigger': 'start', 'source': 'idle', 'dest': 'running'},
+            {'trigger': 'retry', 'source': 'running',
+                'dest': 'running'},  # Self-loop
+        ]
+
+        machine = ReactFlowMachine(
+            states=states, transitions=transitions, initial='idle')
+        graph = machine.get_graph()
+
+        # Find the self-loop edge
+        self_loop = [e for e in graph['edges'] if e['source'] == e['target']]
+        assert len(self_loop) == 1
+        assert self_loop[0]['source'] == 'running'
+        assert self_loop[0]['target'] == 'running'
+
+    def test_multiple_source_states(self):
+        """Test transition from multiple source states."""
+        states = ['idle', 'running', 'paused', 'stopped']
+        transitions = [
+            {'trigger': 'stop', 'source': [
+                'running', 'paused'], 'dest': 'stopped'},
+        ]
+
+        machine = ReactFlowMachine(
+            states=states, transitions=transitions, initial='idle')
+        graph = machine.get_graph()
+
+        # Should create separate edges for each source
+        stop_edges = [e for e in graph['edges'] if e['label'] == 'stop']
+        assert len(stop_edges) == 2
+
+        sources = {e['source'] for e in stop_edges}
+        assert 'running' in sources
+        assert 'paused' in sources
+
+    def test_empty_graph(self):
+        """Test graph with no transitions."""
+        states = ['idle']
+        transitions = []
+
+        machine = ReactFlowMachine(
+            states=states, transitions=transitions, initial='idle')
+        graph = machine.get_graph()
+
+        # No transitions means no nodes (since unused states are filtered)
+        assert len(graph['nodes']) == 0
+        assert len(graph['edges']) == 0
+
+    def test_node_labels(self):
+        """Test that node labels default to state ID."""
+        states = ['idle', 'running']
+        transitions = [
+            {'trigger': 'start', 'source': 'idle', 'dest': 'running'}
+        ]
+
+        machine = ReactFlowMachine(
+            states=states, transitions=transitions, initial='idle')
+        graph = machine.get_graph()
+
+        # Check default labels (same as ID)
+        idle_node = [n for n in graph['nodes'] if n['id'] == 'idle'][0]
+        assert idle_node['data']['label'] == 'idle'
+
+        running_node = [n for n in graph['nodes'] if n['id'] == 'running'][0]
+        assert running_node['data']['label'] == 'running'
+
+    def test_roi_state_parameter(self):
+        """Test that roi_state parameter is accepted (though not implemented)."""
+        states = ['idle', 'running']
+        transitions = [{'trigger': 'start',
+                        'source': 'idle', 'dest': 'running'}]
+
+        machine = ReactFlowMachine(
+            states=states, transitions=transitions, initial='idle')
+        # The roi_state parameter is in the method signature but not used
+        # This test just ensures the method can be called
+        graph = machine.get_graph()
+        assert 'nodes' in graph
+        assert 'edges' in graph
+
+    def test_set_previous_transition(self):
+        """Test set_previous_transition method (no-op for React Flow)."""
+        from transitions_reactflow.diagrams_reactflow import ReactFlowGraph
+
+        graph = ReactFlowGraph(None)
+        # Should not raise an error
+        graph.set_previous_transition('idle', 'running')
+        # Method is no-op, so no assertions needed
+
+    def test_get_graph_exception_handling(self):
+        """Test exception handling in get_graph method."""
+        from transitions_reactflow.diagrams_reactflow import ReactFlowGraph
+        from unittest.mock import patch
+
+        graph = ReactFlowGraph(None)
+
+        # Mock _get_elements to return invalid data that causes an exception
+        with patch.object(graph, '_get_elements', return_value=(None, [])):
+            with pytest.raises(ValueError, match="Failed to generate React Flow graph"):
+                graph.get_graph()