vulcan-core 1.0.0__tar.gz

vulcan_core-1.0.0/LICENSE

@@ -0,0 +1,176 @@
+                                 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

vulcan_core-1.0.0/NOTICE

@@ -0,0 +1,8 @@
+Latchfield Vulcan
+Copyright 2025 Latchfield Technologies
+
+This product includes software developed at
+Latchfield Technologies (http://latchfield.com/).
+
+The initial codebase for Vulcan
+was developed by Nicholas Pace. (https://github.com/segfly)

vulcan_core-1.0.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.3
+Name: vulcan-core
+Version: 1.0.0
+Summary: AI-Hybrid Rules Engine for Logical Reasoning.
+License: Apache-2.0
+Keywords: rules,logic,reasoning,ai,artificial intelligence,RAG,LLM
+Requires-Python: >=3.12,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: openai
+Requires-Dist: langchain ; extra == "openai"
+Requires-Dist: langchain-openai ; extra == "openai"
+Requires-Dist: pydantic (>=2.10.6,<2.11.0)
+Project-URL: Documentation, https://latchfield.com/vulcan/docs
+Project-URL: Homepage, https://latchfield.com/vulcan
+Project-URL: Repository, https://github.com/latchfield/vulcan_core
+Description-Content-Type: text/markdown
+
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+<!-- Copyright 2025 Latchfield Technologies http://latchfield.com -->
+<img alt="Vulcan Logo" src="https://latchfield.com/vulcan/assets/images/vulcan-logo.svg" height="100px">
+
+# AI-Hybrid Rules Engine for Logical Reasoning
+![Version](https://img.shields.io/pypi/v/vulcan_core)
+
+Vulcan is an AI-hybrid rules engine designed for advanced automated reasoning. It combines the power of rule-based decision systems with LLMs (Large Language Models) for improved consistency and explainability in AI-powered systems.
+
+Learn more about Vulcan at [https://latchfield.com/vulcan](https://latchfield.com/vulcan), or jump in with:
+
+```bash
+poetry add vulcan-core
+# or
+pip install vulcan-core
+```
+
+To gain your bearings, read the documentation for guides and API reference: [https://latchfield.com/vulcan/docs](https://latchfield.com/vulcan/docs).
+
+## Why use Vulcan?
+Vulcan strives to improve AI reliability and explainability by explicitly separating computational logic from LLM prediction through declarative rules and microprompting. Vulcan provides developers with a toolkit to create, manage, and execute rules with seamless integration with LLMs and vector databases.
+
+### Features:
+* **AI-Hybrid Rules** - Combine deterministic logic with LLMs and vector databases
+* **Transparent Decision-Making** - Full explainability of how decisions are made
+* **Developer-Friendly API** - Intuitive interfaces for rule creation and management
+* **Platform Flexibility** - Works across various environments and integrates with existing tools
+
+### Simple Example:
+Turn your lengthy unpredictable prompts:
+
+> As a bakery, I want to buy 10 apples if I have less than 10 in inventory, but only if my supplier has apples used for baking in stock. Given I have 9 apples, and my supplier has "Honeycrisp", how many apples should I order?
+
+Into repeatable, consistent, and explainable rules:
+
+```python
+# Use natural language for prediction and data retrieval:
+engine.rule(
+    when(f"Are {Apple.kind} considered good for baking?"),
+    then(Apple(baking=True)),
+)
+
+# Use computed logic for operations that must be correct:
+engine.rule(
+    when(Apple.baking && lambda: Inventory.apples < 10),
+    then(Order(apples=10)),
+)
+
+# Intelligent on-demand rule evaluation:
+engine.fact(Inventory(apples=9))
+engine.fact(Apple(kind="Honeycrisp"))
+```
+
+## Get Involved!
+We welcome contributions from the community to help make Vulcan even better:
+
+* **Contribute Code** - Check out the [contribution guidelines](https://github.com/latchfield/vulcan/blob/main/CONTRIBUTING.md) for information on how to submit pull requests
+* **Report Issues** - Found a bug or have a feature request? Open an issue on our [GitHub repository](https://github.com/latchfield/vulcan-core/issues/)
+* **Join the Community** - Connect with other Vulcan users and developers on [GitHub Discussions](https://github.com/latchfield/vulcan-core/discussions)
+
+## Additional Resources
+Learn more about Vulcan:
+
+* [Core Concepts](https://latchfield.com/vulcan/docs/concepts) - Understand the fundamental principles of Vulcan
+* [Guides & Tutorials](https://latchfield.com/vulcan/docs/guides/quick-start/) - Step-by-step instructions for common use cases
+* [API Reference](https://latchfield.com/vulcan/docs/) - Detailed information about the Vulcan API
+

vulcan_core-1.0.0/README.md

@@ -0,0 +1,66 @@
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+<!-- Copyright 2025 Latchfield Technologies http://latchfield.com -->
+<img alt="Vulcan Logo" src="https://latchfield.com/vulcan/assets/images/vulcan-logo.svg" height="100px">
+
+# AI-Hybrid Rules Engine for Logical Reasoning
+![Version](https://img.shields.io/pypi/v/vulcan_core)
+
+Vulcan is an AI-hybrid rules engine designed for advanced automated reasoning. It combines the power of rule-based decision systems with LLMs (Large Language Models) for improved consistency and explainability in AI-powered systems.
+
+Learn more about Vulcan at [https://latchfield.com/vulcan](https://latchfield.com/vulcan), or jump in with:
+
+```bash
+poetry add vulcan-core
+# or
+pip install vulcan-core
+```
+
+To gain your bearings, read the documentation for guides and API reference: [https://latchfield.com/vulcan/docs](https://latchfield.com/vulcan/docs).
+
+## Why use Vulcan?
+Vulcan strives to improve AI reliability and explainability by explicitly separating computational logic from LLM prediction through declarative rules and microprompting. Vulcan provides developers with a toolkit to create, manage, and execute rules with seamless integration with LLMs and vector databases.
+
+### Features:
+* **AI-Hybrid Rules** - Combine deterministic logic with LLMs and vector databases
+* **Transparent Decision-Making** - Full explainability of how decisions are made
+* **Developer-Friendly API** - Intuitive interfaces for rule creation and management
+* **Platform Flexibility** - Works across various environments and integrates with existing tools
+
+### Simple Example:
+Turn your lengthy unpredictable prompts:
+
+> As a bakery, I want to buy 10 apples if I have less than 10 in inventory, but only if my supplier has apples used for baking in stock. Given I have 9 apples, and my supplier has "Honeycrisp", how many apples should I order?
+
+Into repeatable, consistent, and explainable rules:
+
+```python
+# Use natural language for prediction and data retrieval:
+engine.rule(
+    when(f"Are {Apple.kind} considered good for baking?"),
+    then(Apple(baking=True)),
+)
+
+# Use computed logic for operations that must be correct:
+engine.rule(
+    when(Apple.baking && lambda: Inventory.apples < 10),
+    then(Order(apples=10)),
+)
+
+# Intelligent on-demand rule evaluation:
+engine.fact(Inventory(apples=9))
+engine.fact(Apple(kind="Honeycrisp"))
+```
+
+## Get Involved!
+We welcome contributions from the community to help make Vulcan even better:
+
+* **Contribute Code** - Check out the [contribution guidelines](https://github.com/latchfield/vulcan/blob/main/CONTRIBUTING.md) for information on how to submit pull requests
+* **Report Issues** - Found a bug or have a feature request? Open an issue on our [GitHub repository](https://github.com/latchfield/vulcan-core/issues/)
+* **Join the Community** - Connect with other Vulcan users and developers on [GitHub Discussions](https://github.com/latchfield/vulcan-core/discussions)
+
+## Additional Resources
+Learn more about Vulcan:
+
+* [Core Concepts](https://latchfield.com/vulcan/docs/concepts) - Understand the fundamental principles of Vulcan
+* [Guides & Tutorials](https://latchfield.com/vulcan/docs/guides/quick-start/) - Step-by-step instructions for common use cases
+* [API Reference](https://latchfield.com/vulcan/docs/) - Detailed information about the Vulcan API

vulcan_core-1.0.0/pyproject.toml

@@ -0,0 +1,106 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2025 Latchfield Technologies http://latchfield.com
+[project]
+dynamic = ["version", "dependencies", "classifiers"]
+name = "vulcan-core"
+license="Apache-2.0"
+description = "AI-Hybrid Rules Engine for Logical Reasoning."
+readme = "README.md"
+authors = []
+keywords = ["rules", "logic", "reasoning", "ai", "artificial intelligence", "RAG", "LLM"]
+requires-python = ">=3.12,<4.0"
+
+[project.urls]
+homepage = "https://latchfield.com/vulcan"
+repository = "https://github.com/latchfield/vulcan_core"
+documentation = "https://latchfield.com/vulcan/docs"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+version = "1.0.0" # Update manually, or use plugin
+packages = [{ include = "vulcan_core", from="src" }]
+requires-poetry = "~2.1.1"
+classifiers = [
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Operating System :: OS Independent"
+]
+# These are needed until dependabot issue is resolved: https://github.com/dependabot/dependabot-core/issues/11237
+name = "vulcan-core"
+description = ""
+authors = []
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F", "B", "Q", "N", "UP",
+          "SIM", "YTT", "ASYNC", "S", "A", "COM", "FBT",
+          "C4", "DTZ", "T10", "EM", "DJ", "EXE", "ISC",
+          "ICN", "LOG", "G", "INP", "PIE", "PT", "RSE",
+          "SLF", "TCH", "INT", "PD", "TRY", "PERF1", "PERF4",
+          "FURB", "RUF"]
+
+# Recommended ignore list: https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+ignore = ["E111", "E114", "E117", "D206", "D300", "Q000",
+          "Q001", "Q002", "Q003", "COM812", "COM819",
+          "ISC001", "ISC002", "S311"]
+
+# Ignore some rules for tests
+# https://github.com/astral-sh/ruff/issues/4368#issue-1705468153
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = ["S101", "ARG", "FBT"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+
+[tool.pyright]
+typeCheckingMode = "basic"
+reportUndefinedVariable = false
+
+[tool.pytest.ini_options]
+minversion = "8.3"
+required_plugins = ["pytest-cov"]
+pythonpath = ["src"]
+addopts = "-rA --showlocals --color=yes --tb=short -q --cov-report=html --cov=src"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.coverage.run]
+source = ["src"]
+branch = true # Could be an issue if true for native decoration: https://github.com/microsoft/vscode-python/issues/24156
+
+[tool.poetry.requires-plugins]
+# Not working unless installed via pipx
+#poetry-plugin-up = "0.9.0"
+
+[tool.poetry.dependencies]
+pydantic = "~2.10.6"
+langchain = { version = "~0.3.20", optional = true } 
+langchain-openai = { version = "~0.3.9", optional = true }
+
+[project.optional-dependencies]
+openai = ["langchain", "langchain-openai"]
+
+[tool.poetry.group.test.dependencies]
+pytest = "~8.3.5"
+pytest-asyncio = "~0.26.0"
+pytest-timeout = "~2.3.1"
+pytest-cov = "~6.1.0"
+pytest-xdist = "~3.6.1"
+hypothesis = "~6.130.6"
+doppler-env = "~0.3.1"
+
+[tool.poetry.group.dev.dependencies]
+bandit = "~1.8.3"
+deptry = "~0.23.0"
+langchain-chroma = "~0.2.2" # On py3.13 needs a compiler installed until transitive dependency numpy 1.26.4 has a whl
+ipykernel = "~6.29.5"
+ruff = "~0.11.2"
+pyright = {extras = ["nodejs"], version = "~1.1.398"}
+twine = "~6.1.0"

vulcan_core-1.0.0/src/vulcan_core/__init__.py

@@ -0,0 +1,45 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2025 Latchfield Technologies http://latchfield.com
+
+from vulcan_core.actions import Action, action
+from vulcan_core.ast_utils import (
+    ASTProcessingError,
+    CallableSignatureError,
+    ContractError,
+    NotAFactError,
+    ScopeAccessError,
+)
+from vulcan_core.conditions import (
+    CompoundCondition,
+    Condition,
+    MissingFactError,
+    OnFactChanged,
+    Operator,
+    condition,
+)
+from vulcan_core.engine import InternalStateError, RecursionLimitError, Rule, RuleEngine
+from vulcan_core.models import ActionReturn, ChunkingStrategy, Fact, Similarity
+
+__all__ = [
+    "ASTProcessingError",
+    "Action",
+    "ActionReturn",
+    "CallableSignatureError",
+    "ChunkingStrategy",
+    "CompoundCondition",
+    "Condition",
+    "ContractError",
+    "Fact",
+    "InternalStateError",
+    "MissingFactError",
+    "NotAFactError",
+    "OnFactChanged",
+    "Operator",
+    "RecursionLimitError",
+    "Rule",
+    "RuleEngine",
+    "ScopeAccessError",
+    "Similarity",
+    "action",
+    "condition",
+]

vulcan_core-1.0.0/src/vulcan_core/actions.py

@@ -0,0 +1,28 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2025 Latchfield Technologies http://latchfield.com
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from functools import partial
+
+from vulcan_core.ast_utils import ASTProcessor
+from vulcan_core.models import ActionCallable, ActionReturn, DeclaresFacts, Fact, FactHandler
+
+
+@dataclass(frozen=True, slots=True)
+class Action(FactHandler[ActionCallable, ActionReturn], DeclaresFacts):
+    """
+    Represents a deferred result calculation of a rule.
+    """
+
+    def __call__(self, *args: Fact) -> ActionReturn:
+        return self.func(*args)
+
+
+def action(value: ActionCallable | ActionReturn) -> Action:
+    if not isinstance(value, partial) and callable(value):
+        processed = ASTProcessor[ActionCallable](value, action, ActionReturn)
+        return Action(processed.facts, processed.func)
+    else:
+        return Action((), lambda: value)