diff --git a/.github/workflows/build-push-to-main.yaml b/.github/workflows/build-push-to-main.yaml index 47273aa0..89f68a13 100644 --- a/.github/workflows/build-push-to-main.yaml +++ b/.github/workflows/build-push-to-main.yaml @@ -106,3 +106,10 @@ jobs: cd ext/dapr-ext-fastapi python setup.py sdist bdist_wheel twine upload dist/* + - name: Build and publish dapr-ext-langgraph + env: + TWINE_PASSWORD: ${{ secrets.PYPI_UPLOAD_PASS }} + run: | + cd ext/dapr-ext-langgraph + python setup.py sdist bdist_wheel + twine upload dist/* diff --git a/.github/workflows/build-tag.yaml b/.github/workflows/build-tag.yaml index 176fbaf0..e5a6de47 100644 --- a/.github/workflows/build-tag.yaml +++ b/.github/workflows/build-tag.yaml @@ -115,3 +115,11 @@ jobs: cd ext/dapr-ext-fastapi python setup.py sdist bdist_wheel twine upload dist/* + - name: Build and publish dapr-ext-langgraph + if: startsWith(github.ref_name, 'langgraph-v') + env: + TWINE_PASSWORD: ${{ secrets.PYPI_UPLOAD_PASS }} + run: | + cd ext/dapr-ext-langgraph + python setup.py sdist bdist_wheel + twine upload dist/* diff --git a/dapr-ext-langgraph/LICENSE b/dapr-ext-langgraph/LICENSE new file mode 100644 index 00000000..be033a7f --- /dev/null +++ b/dapr-ext-langgraph/LICENSE @@ -0,0 +1,203 @@ +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 2021 The Dapr Authors. + + and others that have contributed code to the public domain. + + 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. \ No newline at end of file diff --git a/dapr-ext-langgraph/README.rst b/dapr-ext-langgraph/README.rst new file mode 100644 index 00000000..85c101a6 --- /dev/null +++ b/dapr-ext-langgraph/README.rst @@ -0,0 +1,22 @@ +dapr-ext-langgraph extension +======================= + +|pypi| + +.. |pypi| image:: https://badge.fury.io/py/dapr-ext-langgraph.svg + :target: https://pypi.org/project/dapr-ext-langgraph/ + +This is the Dapr Checkpointer extension for LangGraph + +Installation +------------ + +:: + + pip install dapr-ext-langgraph + +References +---------- + +* `Dapr `_ +* `Dapr Python-SDK `_ diff --git a/dapr-ext-langgraph/dapr/ext/langgraph/__init__.py b/dapr-ext-langgraph/dapr/ext/langgraph/__init__.py new file mode 100644 index 00000000..4f2d3cf8 --- /dev/null +++ b/dapr-ext-langgraph/dapr/ext/langgraph/__init__.py @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- + +""" +Copyright 2025 The Dapr Authors +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. +""" + +# Import your main classes here +from dapr.ext.langgraph.dapr_checkpointer import DaprCheckpointer + +__all__ = [ + 'DaprCheckpointer', +] diff --git a/dapr-ext-langgraph/dapr/ext/langgraph/dapr_checkpointer.py b/dapr-ext-langgraph/dapr/ext/langgraph/dapr_checkpointer.py new file mode 100644 index 00000000..123b313d --- /dev/null +++ b/dapr-ext-langgraph/dapr/ext/langgraph/dapr_checkpointer.py @@ -0,0 +1,164 @@ +import json +from typing import Any, Sequence, Tuple + +from langchain_core.load import dumps +from langchain_core.runnables import RunnableConfig + +from dapr.clients import DaprClient +from langgraph.checkpoint.base import BaseCheckpointSaver, Checkpoint, CheckpointTuple + + +class DaprCheckpointer(BaseCheckpointSaver[Checkpoint]): + """ + Dapr-backed LangGraph Checkpointer that persists checkpoints to a Dapr state store. + Compatible with LangGraph >= 0.3.6 and LangChain Core >= 1.0.0. + """ + + REGISTRY_KEY = 'dapr_checkpoint_registry' + + def __init__(self, store_name: str, key_prefix: str): + self.store_name = store_name + self.key_prefix = key_prefix + self.client = DaprClient() + + # helper: construct Dapr key for a thread + def _get_key(self, config: RunnableConfig) -> str: + thread_id = None + + if isinstance(config, dict): + thread_id = config.get('configurable', {}).get('thread_id') + + if not thread_id: + thread_id = config.get('thread_id') + + if not thread_id: + thread_id = 'default' + + return f'{self.key_prefix}:{thread_id}' + + # restore a checkpoint + def get_tuple(self, config: RunnableConfig) -> CheckpointTuple | None: + key = self._get_key(config) + + resp = self.client.get_state(store_name=self.store_name, key=key) + if not resp.data: + return None + + wrapper = json.loads(resp.data) + cp_data = wrapper.get('checkpoint', wrapper) + metadata = wrapper.get('metadata', {'step': 0}) + if 'step' not in metadata: + metadata['step'] = 0 + + cp = Checkpoint(**cp_data) + return CheckpointTuple( + config=config, + checkpoint=cp, + parent_config=None, + metadata=metadata, + ) + + # save a full checkpoint snapshot + def put( + self, + config: RunnableConfig, + checkpoint: Checkpoint, + parent_config: RunnableConfig | None, + metadata: dict[str, Any], + ) -> None: + key = self._get_key(config) + + checkpoint_serializable = { + 'v': checkpoint['v'], + 'id': checkpoint['id'], + 'ts': checkpoint['ts'], + 'channel_values': checkpoint['channel_values'], + 'channel_versions': checkpoint['channel_versions'], + 'versions_seen': checkpoint['versions_seen'], + } + + wrapper = {'checkpoint': checkpoint_serializable, 'metadata': metadata} + + self.client.save_state(self.store_name, key, dumps(wrapper)) + + reg_resp = self.client.get_state(store_name=self.store_name, key=self.REGISTRY_KEY) + registry = json.loads(reg_resp.data) if reg_resp.data else [] + + if key not in registry: + registry.append(key) + self.client.save_state(self.store_name, self.REGISTRY_KEY, json.dumps(registry)) + + # incremental persistence (for streamed runs) + def put_writes( + self, + config: RunnableConfig, + writes: Sequence[Tuple[str, Any]], + task_id: str, + task_path: str = '', + ) -> None: + _ = task_id, task_path + + key = self._get_key(config) + + resp = self.client.get_state(store_name=self.store_name, key=key) + if not resp.data: + return + + wrapper = json.loads(resp.data) + cp = wrapper.get('checkpoint', {}) + + for field, value in writes: + cp['channel_values'][field] = value + + wrapper['checkpoint'] = cp + self.client.save_state(self.store_name, key, json.dumps(wrapper)) + + # enumerate all saved checkpoints + def list(self, config: RunnableConfig) -> list[CheckpointTuple]: + reg_resp = self.client.get_state(store_name=self.store_name, key=self.REGISTRY_KEY) + if not reg_resp.data: + return [] + + keys = json.loads(reg_resp.data) + checkpoints: list[CheckpointTuple] = [] + + for key in keys: + cp_resp = self.client.get_state(store_name=self.store_name, key=key) + if not cp_resp.data: + continue + + wrapper = json.loads(cp_resp.data) + cp_data = wrapper.get('checkpoint', {}) + metadata = wrapper.get('metadata', {}) + cp = Checkpoint(**cp_data) + + checkpoints.append( + CheckpointTuple( + config=config, + checkpoint=cp, + parent_config=None, + metadata=metadata, + ) + ) + + return checkpoints + + # remove a checkpoint and update the registry + def delete_thread(self, config: RunnableConfig) -> None: + key = self._get_key(config) + + self.client.delete_state(store_name=self.store_name, key=key) + + reg_resp = self.client.get_state(store_name=self.store_name, key=self.REGISTRY_KEY) + if not reg_resp.data: + return + + registry = json.loads(reg_resp.data) + + if key in registry: + registry.remove(key) + self.client.save_state( + store_name=self.store_name, + key=self.REGISTRY_KEY, + value=json.dumps(registry), + ) diff --git a/dapr-ext-langgraph/dapr/ext/langgraph/version.py b/dapr-ext-langgraph/dapr/ext/langgraph/version.py new file mode 100644 index 00000000..dae1485d --- /dev/null +++ b/dapr-ext-langgraph/dapr/ext/langgraph/version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- + +""" +Copyright 2025 The Dapr Authors +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. +""" + +__version__ = '1.16.0.dev' diff --git a/dapr-ext-langgraph/setup.cfg b/dapr-ext-langgraph/setup.cfg new file mode 100644 index 00000000..bb32e782 --- /dev/null +++ b/dapr-ext-langgraph/setup.cfg @@ -0,0 +1,36 @@ +[metadata] +url = https://dapr.io/ +author = Dapr Authors +author_email = daprweb@microsoft.com +license = Apache +license_file = LICENSE +classifiers = + Development Status :: 5 - Production/Stable + Intended Audience :: Developers + License :: OSI Approved :: Apache Software License + Operating System :: OS Independent + Programming Language :: Python + Programming Language :: Python :: 3.10 + Programming Language :: Python :: 3.11 + Programming Language :: Python :: 3.12 + Programming Language :: Python :: 3.13 + Programming Language :: Python :: 3.14 +project_urls = + Documentation = https://github.com/dapr/docs + Source = https://github.com/dapr/python-sdk + +[options] +python_requires = >=3.10 +packages = find_namespace: +include_package_data = True +install_requires = + dapr >= 1.16.1rc1 + langgraph >= 0.3.6 + langchain >= 0.1.17 + +[options.packages.find] +include = + dapr.* + +exclude = + tests diff --git a/dapr-ext-langgraph/setup.py b/dapr-ext-langgraph/setup.py new file mode 100644 index 00000000..78c0daac --- /dev/null +++ b/dapr-ext-langgraph/setup.py @@ -0,0 +1,66 @@ +# -*- coding: utf-8 -*- + +""" +Copyright 2025 The Dapr Authors +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. +""" + +import os + +from setuptools import setup + +# Load version in dapr package. +version_info = {} +with open('dapr/ext/langgraph/version.py') as fp: + exec(fp.read(), version_info) +__version__ = version_info['__version__'] + + +def is_release(): + return '.dev' not in __version__ + + +name = 'dapr-ext-langgraph' +version = __version__ +description = 'The official release of Dapr Python SDK LangGraph Extension.' +long_description = """ +This is the Dapr Checkpointer extension for LangGraph. + +Dapr is a portable, serverless, event-driven runtime that makes it easy for developers to +build resilient, stateless and stateful microservices that run on the cloud and edge and +embraces the diversity of languages and developer frameworks. + +Dapr codifies the best practices for building microservice applications into open, +independent, building blocks that enable you to build portable applications with the language +and framework of your choice. Each building block is independent and you can use one, some, +or all of them in your application. +""".lstrip() + +# Get build number from GITHUB_RUN_NUMBER environment variable +build_number = os.environ.get('GITHUB_RUN_NUMBER', '0') + +if not is_release(): + name += '-dev' + version = f'{__version__}{build_number}' + description = 'The developmental release for the Dapr Checkpointer extension for LangGraph' + long_description = ( + 'This is the developmental release for the Dapr Checkpointer extension for LangGraph' + ) + +print(f'package name: {name}, version: {version}', flush=True) + + +setup( + name=name, + version=version, + description=description, + long_description=long_description, +)