cjm-workflow-state 0.0.2__tar.gz

cjm_workflow_state-0.0.2/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022, fastai
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cjm_workflow_state-0.0.2/MANIFEST.in

@@ -0,0 +1,5 @@
+include settings.ini
+include LICENSE
+include CONTRIBUTING.md
+include README.md
+recursive-exclude * __pycache__

cjm_workflow_state-0.0.2/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: cjm-workflow-state
+Version: 0.0.2
+Summary: SQLite-backed workflow state persistence and undo history for multi-step human-in-the-loop workflows.
+Home-page: https://github.com/cj-mills/cjm-workflow-state
+Author: Christian J. Mills
+Author-email: 9126128+cj-mills@users.noreply.github.com
+License: Apache-2.0
+Keywords: nbdev jupyter notebook python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-python
+Dynamic: summary
+
+# cjm-workflow-state
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Install
+
+``` bash
+pip install cjm_workflow_state
+```
+
+## Project Structure
+
+    nbs/
+    ├── history.ipynb     # Generic undo history stack for workflow operations.
+    └── state_store.ipynb # SQLite-backed workflow state storage for persistence across restarts.
+
+Total: 2 notebooks
+
+## Module Dependencies
+
+``` mermaid
+graph LR
+    history[history<br/>History]
+    state_store[state_store<br/>State Store]
+```
+
+No cross-module dependencies detected.
+
+## CLI Reference
+
+No CLI commands found in this project.
+
+## Module Overview
+
+Detailed documentation for each module in the project:
+
+### History (`history.ipynb`)
+
+> Generic undo history stack for workflow operations.
+
+#### Import
+
+``` python
+from cjm_workflow_state.history import (
+    DEFAULT_MAX_HISTORY_DEPTH,
+    push_history,
+    pop_history
+)
+```
+
+#### Functions
+
+``` python
+def push_history(
+    history: List[Dict[str, Any]],  # Current history stack
+    snapshot: Dict[str, Any],  # State snapshot to save
+    max_depth: int = DEFAULT_MAX_HISTORY_DEPTH,  # Maximum history depth
+) -> List[Dict[str, Any]]:  # Updated history stack
+    "Push a state snapshot onto the history stack, enforcing max depth."
+```
+
+``` python
+def pop_history(
+    history: List[Dict[str, Any]],  # Current history stack
+) -> Optional[Tuple[Dict[str, Any], List[Dict[str, Any]]]]:  # (snapshot, updated_history) or None
+    "Pop the most recent snapshot from the history stack."
+```
+
+#### Variables
+
+``` python
+DEFAULT_MAX_HISTORY_DEPTH = 50
+```
+
+### State Store (`state_store.ipynb`)
+
+> SQLite-backed workflow state storage for persistence across restarts.
+
+#### Import
+
+``` python
+from cjm_workflow_state.state_store import (
+    SQLiteWorkflowStateStore
+)
+```
+
+#### Classes
+
+``` python
+class SQLiteWorkflowStateStore:
+    def __init__(
+        self,
+        db_path: Path  # Path to SQLite database file
+    )
+    "SQLite-backed workflow state storage for persistence across restarts."
+    
+    def __init__(
+            self,
+            db_path: Path  # Path to SQLite database file
+        )
+        "Initialize the state store and create tables if needed."
+    
+    def get_current_step(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str  # Session identifier string
+        ) -> Optional[str]:  # Current step ID or None
+        "Get current step ID for a workflow."
+    
+    def set_current_step(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            step_id: str  # Step ID to set as current
+        ) -> None
+        "Set current step ID for a workflow."
+    
+    def get_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str  # Session identifier string
+        ) -> Dict[str, Any]:  # Workflow state dictionary
+        "Get all workflow state."
+    
+    def update_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            updates: Dict[str, Any]  # State updates to merge
+        ) -> None
+        "Update workflow state by merging new values."
+    
+    def clear_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str  # Session identifier string
+        ) -> None
+        "Clear all workflow state."
+    
+    def get_step_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            step_id: str  # Step identifier
+        ) -> Dict[str, Any]:  # Step-specific state dictionary
+        "Get state for a specific step."
+    
+    def update_step_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            step_id: str,  # Step identifier
+            updates: Dict[str, Any]  # Step-specific state updates
+        ) -> None
+        "Update state for a specific step."
+    
+    def clear_step_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            step_id: str  # Step identifier
+        ) -> None
+        "Clear state for a specific step."
+```

cjm_workflow_state-0.0.2/README.md

@@ -0,0 +1,165 @@
+# cjm-workflow-state
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Install
+
+``` bash
+pip install cjm_workflow_state
+```
+
+## Project Structure
+
+    nbs/
+    ├── history.ipynb     # Generic undo history stack for workflow operations.
+    └── state_store.ipynb # SQLite-backed workflow state storage for persistence across restarts.
+
+Total: 2 notebooks
+
+## Module Dependencies
+
+``` mermaid
+graph LR
+    history[history<br/>History]
+    state_store[state_store<br/>State Store]
+```
+
+No cross-module dependencies detected.
+
+## CLI Reference
+
+No CLI commands found in this project.
+
+## Module Overview
+
+Detailed documentation for each module in the project:
+
+### History (`history.ipynb`)
+
+> Generic undo history stack for workflow operations.
+
+#### Import
+
+``` python
+from cjm_workflow_state.history import (
+    DEFAULT_MAX_HISTORY_DEPTH,
+    push_history,
+    pop_history
+)
+```
+
+#### Functions
+
+``` python
+def push_history(
+    history: List[Dict[str, Any]],  # Current history stack
+    snapshot: Dict[str, Any],  # State snapshot to save
+    max_depth: int = DEFAULT_MAX_HISTORY_DEPTH,  # Maximum history depth
+) -> List[Dict[str, Any]]:  # Updated history stack
+    "Push a state snapshot onto the history stack, enforcing max depth."
+```
+
+``` python
+def pop_history(
+    history: List[Dict[str, Any]],  # Current history stack
+) -> Optional[Tuple[Dict[str, Any], List[Dict[str, Any]]]]:  # (snapshot, updated_history) or None
+    "Pop the most recent snapshot from the history stack."
+```
+
+#### Variables
+
+``` python
+DEFAULT_MAX_HISTORY_DEPTH = 50
+```
+
+### State Store (`state_store.ipynb`)
+
+> SQLite-backed workflow state storage for persistence across restarts.
+
+#### Import
+
+``` python
+from cjm_workflow_state.state_store import (
+    SQLiteWorkflowStateStore
+)
+```
+
+#### Classes
+
+``` python
+class SQLiteWorkflowStateStore:
+    def __init__(
+        self,
+        db_path: Path  # Path to SQLite database file
+    )
+    "SQLite-backed workflow state storage for persistence across restarts."
+    
+    def __init__(
+            self,
+            db_path: Path  # Path to SQLite database file
+        )
+        "Initialize the state store and create tables if needed."
+    
+    def get_current_step(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str  # Session identifier string
+        ) -> Optional[str]:  # Current step ID or None
+        "Get current step ID for a workflow."
+    
+    def set_current_step(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            step_id: str  # Step ID to set as current
+        ) -> None
+        "Set current step ID for a workflow."
+    
+    def get_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str  # Session identifier string
+        ) -> Dict[str, Any]:  # Workflow state dictionary
+        "Get all workflow state."
+    
+    def update_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            updates: Dict[str, Any]  # State updates to merge
+        ) -> None
+        "Update workflow state by merging new values."
+    
+    def clear_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str  # Session identifier string
+        ) -> None
+        "Clear all workflow state."
+    
+    def get_step_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            step_id: str  # Step identifier
+        ) -> Dict[str, Any]:  # Step-specific state dictionary
+        "Get state for a specific step."
+    
+    def update_step_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            step_id: str,  # Step identifier
+            updates: Dict[str, Any]  # Step-specific state updates
+        ) -> None
+        "Update state for a specific step."
+    
+    def clear_step_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            step_id: str  # Step identifier
+        ) -> None
+        "Clear state for a specific step."
+```

cjm_workflow_state-0.0.2/cjm_workflow_state/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.2"

cjm_workflow_state-0.0.2/cjm_workflow_state/_modidx.py

@@ -0,0 +1,37 @@
+# Autogenerated by nbdev
+
+d = { 'settings': { 'branch': 'main',
+                'doc_baseurl': '/cjm-workflow-state',
+                'doc_host': 'https://cj-mills.github.io',
+                'git_url': 'https://github.com/cj-mills/cjm-workflow-state',
+                'lib_path': 'cjm_workflow_state'},
+  'syms': { 'cjm_workflow_state.history': { 'cjm_workflow_state.history.pop_history': ( 'history.html#pop_history',
+                                                                                        'cjm_workflow_state/history.py'),
+                                            'cjm_workflow_state.history.push_history': ( 'history.html#push_history',
+                                                                                         'cjm_workflow_state/history.py')},
+            'cjm_workflow_state.state_store': { 'cjm_workflow_state.state_store.SQLiteWorkflowStateStore': ( 'state_store.html#sqliteworkflowstatestore',
+                                                                                                             'cjm_workflow_state/state_store.py'),
+                                                'cjm_workflow_state.state_store.SQLiteWorkflowStateStore.__init__': ( 'state_store.html#sqliteworkflowstatestore.__init__',
+                                                                                                                      'cjm_workflow_state/state_store.py'),
+                                                'cjm_workflow_state.state_store.SQLiteWorkflowStateStore._get_connection': ( 'state_store.html#sqliteworkflowstatestore._get_connection',
+                                                                                                                             'cjm_workflow_state/state_store.py'),
+                                                'cjm_workflow_state.state_store.SQLiteWorkflowStateStore._init_db': ( 'state_store.html#sqliteworkflowstatestore._init_db',
+                                                                                                                      'cjm_workflow_state/state_store.py'),
+                                                'cjm_workflow_state.state_store.SQLiteWorkflowStateStore._make_key': ( 'state_store.html#sqliteworkflowstatestore._make_key',
+                                                                                                                       'cjm_workflow_state/state_store.py'),
+                                                'cjm_workflow_state.state_store.SQLiteWorkflowStateStore.clear_state': ( 'state_store.html#sqliteworkflowstatestore.clear_state',
+                                                                                                                         'cjm_workflow_state/state_store.py'),
+                                                'cjm_workflow_state.state_store.SQLiteWorkflowStateStore.clear_step_state': ( 'state_store.html#sqliteworkflowstatestore.clear_step_state',
+                                                                                                                              'cjm_workflow_state/state_store.py'),
+                                                'cjm_workflow_state.state_store.SQLiteWorkflowStateStore.get_current_step': ( 'state_store.html#sqliteworkflowstatestore.get_current_step',
+                                                                                                                              'cjm_workflow_state/state_store.py'),
+                                                'cjm_workflow_state.state_store.SQLiteWorkflowStateStore.get_state': ( 'state_store.html#sqliteworkflowstatestore.get_state',
+                                                                                                                       'cjm_workflow_state/state_store.py'),
+                                                'cjm_workflow_state.state_store.SQLiteWorkflowStateStore.get_step_state': ( 'state_store.html#sqliteworkflowstatestore.get_step_state',
+                                                                                                                            'cjm_workflow_state/state_store.py'),
+                                                'cjm_workflow_state.state_store.SQLiteWorkflowStateStore.set_current_step': ( 'state_store.html#sqliteworkflowstatestore.set_current_step',
+                                                                                                                              'cjm_workflow_state/state_store.py'),
+                                                'cjm_workflow_state.state_store.SQLiteWorkflowStateStore.update_state': ( 'state_store.html#sqliteworkflowstatestore.update_state',
+                                                                                                                          'cjm_workflow_state/state_store.py'),
+                                                'cjm_workflow_state.state_store.SQLiteWorkflowStateStore.update_step_state': ( 'state_store.html#sqliteworkflowstatestore.update_step_state',
+                                                                                                                               'cjm_workflow_state/state_store.py')}}}

cjm_workflow_state-0.0.2/cjm_workflow_state/history.py

@@ -0,0 +1,36 @@
+"""Generic undo history stack for workflow operations."""
+
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/history.ipynb.
+
+# %% auto #0
+__all__ = ['DEFAULT_MAX_HISTORY_DEPTH', 'push_history', 'pop_history']
+
+# %% ../nbs/history.ipynb #hist-imports
+from typing import Optional, Tuple, List, Dict, Any
+
+# %% ../nbs/history.ipynb #hist-const
+DEFAULT_MAX_HISTORY_DEPTH = 50
+
+# %% ../nbs/history.ipynb #hist-push
+def push_history(
+    history: List[Dict[str, Any]],  # Current history stack
+    snapshot: Dict[str, Any],  # State snapshot to save
+    max_depth: int = DEFAULT_MAX_HISTORY_DEPTH,  # Maximum history depth
+) -> List[Dict[str, Any]]:  # Updated history stack
+    """Push a state snapshot onto the history stack, enforcing max depth."""
+    new_history = list(history)
+    new_history.append(snapshot)
+    if len(new_history) > max_depth:
+        new_history = new_history[-max_depth:]
+    return new_history
+
+# %% ../nbs/history.ipynb #hist-pop
+def pop_history(
+    history: List[Dict[str, Any]],  # Current history stack
+) -> Optional[Tuple[Dict[str, Any], List[Dict[str, Any]]]]:  # (snapshot, updated_history) or None
+    """Pop the most recent snapshot from the history stack."""
+    if not history:
+        return None
+    new_history = list(history)
+    snapshot = new_history.pop()
+    return snapshot, new_history

cjm_workflow_state-0.0.2/cjm_workflow_state/state_store.py

@@ -0,0 +1,185 @@
+"""SQLite-backed workflow state storage for persistence across restarts."""
+
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/state_store.ipynb.
+
+# %% auto #0
+__all__ = ['SQLiteWorkflowStateStore']
+
+# %% ../nbs/state_store.ipynb #ss-imports
+import json
+import sqlite3
+from pathlib import Path
+from typing import Dict, Any, Optional
+from contextlib import contextmanager
+
+# %% ../nbs/state_store.ipynb #ss-class
+class SQLiteWorkflowStateStore:
+    """SQLite-backed workflow state storage for persistence across restarts."""
+    
+    def __init__(
+        self,
+        db_path: Path  # Path to SQLite database file
+    ):
+        """Initialize the state store and create tables if needed."""
+        self.db_path = Path(db_path)
+        self.db_path.parent.mkdir(parents=True, exist_ok=True)
+        self._init_db()
+    
+    @contextmanager
+    def _get_connection(self):  # Context manager yielding SQLite connection
+        """Get a database connection with proper cleanup."""
+        conn = sqlite3.connect(self.db_path)
+        conn.row_factory = sqlite3.Row
+        try:
+            yield conn
+            conn.commit()
+        finally:
+            conn.close()
+    
+    def _init_db(self) -> None:
+        """Initialize database schema."""
+        with self._get_connection() as conn:
+            conn.execute("""
+                CREATE TABLE IF NOT EXISTS workflow_state (
+                    flow_session_key TEXT PRIMARY KEY,
+                    current_step TEXT,
+                    state_json TEXT DEFAULT '{}',
+                    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+                    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+                )
+            """)
+            conn.execute("""
+                CREATE INDEX IF NOT EXISTS idx_workflow_state_updated
+                ON workflow_state(updated_at)
+            """)
+    
+    def _make_key(
+        self,
+        flow_id: str,  # Workflow identifier
+        session_id: str  # Session identifier string
+    ) -> str:  # Composite key for storage
+        """Create composite key from flow_id and session_id."""
+        return f"{flow_id}:{session_id}"
+    
+    def get_current_step(
+        self,
+        flow_id: str,  # Workflow identifier
+        session_id: str  # Session identifier string
+    ) -> Optional[str]:  # Current step ID or None
+        """Get current step ID for a workflow."""
+        key = self._make_key(flow_id, session_id)
+        with self._get_connection() as conn:
+            row = conn.execute(
+                "SELECT current_step FROM workflow_state WHERE flow_session_key = ?",
+                (key,)
+            ).fetchone()
+            return row["current_step"] if row else None
+    
+    def set_current_step(
+        self,
+        flow_id: str,  # Workflow identifier
+        session_id: str,  # Session identifier string
+        step_id: str  # Step ID to set as current
+    ) -> None:
+        """Set current step ID for a workflow."""
+        key = self._make_key(flow_id, session_id)
+        with self._get_connection() as conn:
+            conn.execute("""
+                INSERT INTO workflow_state (flow_session_key, current_step)
+                VALUES (?, ?)
+                ON CONFLICT(flow_session_key) DO UPDATE SET
+                    current_step = excluded.current_step,
+                    updated_at = CURRENT_TIMESTAMP
+            """, (key, step_id))
+    
+    def get_state(
+        self,
+        flow_id: str,  # Workflow identifier
+        session_id: str  # Session identifier string
+    ) -> Dict[str, Any]:  # Workflow state dictionary
+        """Get all workflow state."""
+        key = self._make_key(flow_id, session_id)
+        with self._get_connection() as conn:
+            row = conn.execute(
+                "SELECT state_json FROM workflow_state WHERE flow_session_key = ?",
+                (key,)
+            ).fetchone()
+            if row and row["state_json"]:
+                return json.loads(row["state_json"])
+            return {}
+    
+    def update_state(
+        self,
+        flow_id: str,  # Workflow identifier
+        session_id: str,  # Session identifier string
+        updates: Dict[str, Any]  # State updates to merge
+    ) -> None:
+        """Update workflow state by merging new values."""
+        key = self._make_key(flow_id, session_id)
+        current_state = self.get_state(flow_id, session_id)
+        current_state.update(updates)
+        state_json = json.dumps(current_state)
+        with self._get_connection() as conn:
+            conn.execute("""
+                INSERT INTO workflow_state (flow_session_key, state_json)
+                VALUES (?, ?)
+                ON CONFLICT(flow_session_key) DO UPDATE SET
+                    state_json = excluded.state_json,
+                    updated_at = CURRENT_TIMESTAMP
+            """, (key, state_json))
+    
+    def clear_state(
+        self,
+        flow_id: str,  # Workflow identifier
+        session_id: str  # Session identifier string
+    ) -> None:
+        """Clear all workflow state."""
+        key = self._make_key(flow_id, session_id)
+        with self._get_connection() as conn:
+            conn.execute(
+                "DELETE FROM workflow_state WHERE flow_session_key = ?",
+                (key,)
+            )
+    
+    def get_step_state(
+        self,
+        flow_id: str,  # Workflow identifier
+        session_id: str,  # Session identifier string
+        step_id: str  # Step identifier
+    ) -> Dict[str, Any]:  # Step-specific state dictionary
+        """Get state for a specific step."""
+        state = self.get_state(flow_id, session_id)
+        step_key = f"_step_{step_id}"
+        return state.get(step_key, {})
+    
+    def update_step_state(
+        self,
+        flow_id: str,  # Workflow identifier
+        session_id: str,  # Session identifier string
+        step_id: str,  # Step identifier
+        updates: Dict[str, Any]  # Step-specific state updates
+    ) -> None:
+        """Update state for a specific step."""
+        step_key = f"_step_{step_id}"
+        current_step_state = self.get_step_state(flow_id, session_id, step_id)
+        current_step_state.update(updates)
+        self.update_state(flow_id, session_id, {step_key: current_step_state})
+    
+    def clear_step_state(
+        self,
+        flow_id: str,  # Workflow identifier
+        session_id: str,  # Session identifier string
+        step_id: str  # Step identifier
+    ) -> None:
+        """Clear state for a specific step."""
+        step_key = f"_step_{step_id}"
+        state = self.get_state(flow_id, session_id)
+        if step_key in state:
+            del state[step_key]
+            key = self._make_key(flow_id, session_id)
+            state_json = json.dumps(state)
+            with self._get_connection() as conn:
+                conn.execute("""
+                    UPDATE workflow_state SET state_json = ?, updated_at = CURRENT_TIMESTAMP
+                    WHERE flow_session_key = ?
+                """, (state_json, key))

cjm_workflow_state-0.0.2/cjm_workflow_state.egg-info/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: cjm-workflow-state
+Version: 0.0.2
+Summary: SQLite-backed workflow state persistence and undo history for multi-step human-in-the-loop workflows.
+Home-page: https://github.com/cj-mills/cjm-workflow-state
+Author: Christian J. Mills
+Author-email: 9126128+cj-mills@users.noreply.github.com
+License: Apache-2.0
+Keywords: nbdev jupyter notebook python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-python
+Dynamic: summary
+
+# cjm-workflow-state
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Install
+
+``` bash
+pip install cjm_workflow_state
+```
+
+## Project Structure
+
+    nbs/
+    ├── history.ipynb     # Generic undo history stack for workflow operations.
+    └── state_store.ipynb # SQLite-backed workflow state storage for persistence across restarts.
+
+Total: 2 notebooks
+
+## Module Dependencies
+
+``` mermaid
+graph LR
+    history[history<br/>History]
+    state_store[state_store<br/>State Store]
+```
+
+No cross-module dependencies detected.
+
+## CLI Reference
+
+No CLI commands found in this project.
+
+## Module Overview
+
+Detailed documentation for each module in the project:
+
+### History (`history.ipynb`)
+
+> Generic undo history stack for workflow operations.
+
+#### Import
+
+``` python
+from cjm_workflow_state.history import (
+    DEFAULT_MAX_HISTORY_DEPTH,
+    push_history,
+    pop_history
+)
+```
+
+#### Functions
+
+``` python
+def push_history(
+    history: List[Dict[str, Any]],  # Current history stack
+    snapshot: Dict[str, Any],  # State snapshot to save
+    max_depth: int = DEFAULT_MAX_HISTORY_DEPTH,  # Maximum history depth
+) -> List[Dict[str, Any]]:  # Updated history stack
+    "Push a state snapshot onto the history stack, enforcing max depth."
+```
+
+``` python
+def pop_history(
+    history: List[Dict[str, Any]],  # Current history stack
+) -> Optional[Tuple[Dict[str, Any], List[Dict[str, Any]]]]:  # (snapshot, updated_history) or None
+    "Pop the most recent snapshot from the history stack."
+```
+
+#### Variables
+
+``` python
+DEFAULT_MAX_HISTORY_DEPTH = 50
+```
+
+### State Store (`state_store.ipynb`)
+
+> SQLite-backed workflow state storage for persistence across restarts.
+
+#### Import
+
+``` python
+from cjm_workflow_state.state_store import (
+    SQLiteWorkflowStateStore
+)
+```
+
+#### Classes
+
+``` python
+class SQLiteWorkflowStateStore:
+    def __init__(
+        self,
+        db_path: Path  # Path to SQLite database file
+    )
+    "SQLite-backed workflow state storage for persistence across restarts."
+    
+    def __init__(
+            self,
+            db_path: Path  # Path to SQLite database file
+        )
+        "Initialize the state store and create tables if needed."
+    
+    def get_current_step(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str  # Session identifier string
+        ) -> Optional[str]:  # Current step ID or None
+        "Get current step ID for a workflow."
+    
+    def set_current_step(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            step_id: str  # Step ID to set as current
+        ) -> None
+        "Set current step ID for a workflow."
+    
+    def get_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str  # Session identifier string
+        ) -> Dict[str, Any]:  # Workflow state dictionary
+        "Get all workflow state."
+    
+    def update_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            updates: Dict[str, Any]  # State updates to merge
+        ) -> None
+        "Update workflow state by merging new values."
+    
+    def clear_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str  # Session identifier string
+        ) -> None
+        "Clear all workflow state."
+    
+    def get_step_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            step_id: str  # Step identifier
+        ) -> Dict[str, Any]:  # Step-specific state dictionary
+        "Get state for a specific step."
+    
+    def update_step_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            step_id: str,  # Step identifier
+            updates: Dict[str, Any]  # Step-specific state updates
+        ) -> None
+        "Update state for a specific step."
+    
+    def clear_step_state(
+            self,
+            flow_id: str,  # Workflow identifier
+            session_id: str,  # Session identifier string
+            step_id: str  # Step identifier
+        ) -> None
+        "Clear state for a specific step."
+```

cjm_workflow_state-0.0.2/cjm_workflow_state.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+settings.ini
+setup.py
+cjm_workflow_state/__init__.py
+cjm_workflow_state/_modidx.py
+cjm_workflow_state/history.py
+cjm_workflow_state/state_store.py
+cjm_workflow_state.egg-info/PKG-INFO
+cjm_workflow_state.egg-info/SOURCES.txt
+cjm_workflow_state.egg-info/dependency_links.txt
+cjm_workflow_state.egg-info/entry_points.txt
+cjm_workflow_state.egg-info/not-zip-safe
+cjm_workflow_state.egg-info/requires.txt
+cjm_workflow_state.egg-info/top_level.txt

cjm_workflow_state-0.0.2/cjm_workflow_state.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

cjm_workflow_state-0.0.2/cjm_workflow_state.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[nbdev]
+cjm_workflow_state = cjm_workflow_state._modidx:d

cjm_workflow_state-0.0.2/cjm_workflow_state.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

cjm_workflow_state-0.0.2/cjm_workflow_state.egg-info/requires.txt

@@ -0,0 +1,2 @@
+
+[dev]

cjm_workflow_state-0.0.2/cjm_workflow_state.egg-info/top_level.txt

@@ -0,0 +1 @@
+cjm_workflow_state

cjm_workflow_state-0.0.2/pyproject.toml

@@ -0,0 +1,11 @@
+[build-system]
+requires = ["setuptools>=64.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name="cjm-workflow-state"
+requires-python=">=3.12"
+dynamic = [ "keywords", "description", "version", "dependencies", "optional-dependencies", "readme", "license", "authors", "classifiers", "entry-points", "scripts", "urls"]
+
+[tool.uv]
+cache-keys = [{ file = "pyproject.toml" }, { file = "settings.ini" }, { file = "setup.py" }]

cjm_workflow_state-0.0.2/settings.ini

@@ -0,0 +1,37 @@
+[DEFAULT]
+repo = cjm-workflow-state
+lib_name = cjm-workflow-state
+version = 0.0.2
+min_python = 3.12
+license = apache2
+black_formatting = False
+doc_path = _docs
+lib_path = cjm_workflow_state
+nbs_path = nbs
+recursive = True
+tst_flags = notest
+put_version_in_init = True
+update_pyproject = True
+branch = main
+custom_sidebar = False
+doc_host = https://cj-mills.github.io
+doc_baseurl = /cjm-workflow-state
+git_url = https://github.com/cj-mills/cjm-workflow-state
+title = cjm-workflow-state
+audience = Developers
+author = Christian J. Mills
+author_email = 9126128+cj-mills@users.noreply.github.com
+copyright = 2026 onwards, Christian J. Mills
+description = SQLite-backed workflow state persistence and undo history for multi-step human-in-the-loop workflows.
+keywords = nbdev jupyter notebook python
+language = English
+status = 3
+user = cj-mills
+readme_nb = index.ipynb
+allowed_metadata_keys = 
+allowed_cell_metadata_keys = 
+jupyter_hooks = False
+clean_ids = True
+clear_all = False
+skip_procs = 
+

cjm_workflow_state-0.0.2/setup.cfg

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

cjm_workflow_state-0.0.2/setup.py

@@ -0,0 +1,63 @@
+from pkg_resources import parse_version
+from configparser import ConfigParser
+import setuptools, shlex
+assert parse_version(setuptools.__version__)>=parse_version('36.2')
+
+# note: all settings are in settings.ini; edit there, not here
+config = ConfigParser(delimiters=['='])
+config.read('settings.ini', encoding='utf-8')
+cfg = config['DEFAULT']
+
+cfg_keys = 'version description keywords author author_email'.split()
+expected = cfg_keys + "lib_name user branch license status min_python audience language".split()
+for o in expected: assert o in cfg, "missing expected setting: {}".format(o)
+setup_cfg = {o:cfg[o] for o in cfg_keys}
+
+licenses = {
+    'apache2': 'Apache-2.0',
+    'mit': 'MIT',
+    'gpl2': 'GPL-2.0-only',
+    'gpl3': 'GPL-3.0-or-later',
+    'bsd3': 'BSD-3-Clause',
+}
+statuses = [ '1 - Planning', '2 - Pre-Alpha', '3 - Alpha',
+    '4 - Beta', '5 - Production/Stable', '6 - Mature', '7 - Inactive' ]
+py_versions = '3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13'.split()
+
+requirements = shlex.split(cfg.get('requirements', ''))
+if cfg.get('pip_requirements'): requirements += shlex.split(cfg.get('pip_requirements', ''))
+min_python = cfg['min_python']
+dev_requirements = (cfg.get('dev_requirements') or '').split()
+
+package_data = dict()
+pkg_data = cfg.get('package_data', None)
+if pkg_data:
+    package_data[cfg['lib_name']] =  pkg_data.split() # split as multiple files might be listed
+# Add package data to setup_cfg for setuptools.setup(..., **setup_cfg)
+setup_cfg['package_data'] = package_data
+
+setuptools.setup(
+    name = cfg['lib_name'],
+    license = licenses.get(cfg['license'].lower(), cfg['license']),
+    classifiers = [
+        'Development Status :: ' + statuses[int(cfg['status'])],
+        'Intended Audience :: ' + cfg['audience'].title(),
+        'Natural Language :: ' + cfg['language'].title(),
+    ] + ['Programming Language :: Python :: '+o for o in py_versions[py_versions.index(min_python):]],
+    url = cfg['git_url'],
+    packages = setuptools.find_packages(),
+    include_package_data = True,
+    install_requires = requirements,
+    extras_require={ 'dev': dev_requirements },
+    dependency_links = cfg.get('dep_links','').split(),
+    python_requires  = '>=' + cfg['min_python'],
+    long_description = open('README.md', encoding='utf-8').read(),
+    long_description_content_type = 'text/markdown',
+    zip_safe = False,
+    entry_points = {
+        'console_scripts': cfg.get('console_scripts','').split(),
+        'nbdev': [f'{cfg.get("lib_path")}={cfg.get("lib_path")}._modidx:d']
+    },
+    **setup_cfg)
+
+