Metadata-Version: 2.4
Name: failcore
Version: 0.1.2
Summary: A minimal execution runtime and tracing toolkit for agent plans.
Author: ZiLing(FailCore)
License:                                  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.
        
           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.
        
           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.
        
           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
License-File: LICENSE
Keywords: agent,debugging,execution,forensics,runtime,tracing
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Debuggers
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Provides-Extra: dev
Requires-Dist: build>=1.2.2; extra == 'dev'
Requires-Dist: pytest>=9.0.2; extra == 'dev'
Requires-Dist: ruff>=0.6.0; extra == 'dev'
Requires-Dist: twine>=5.1.1; extra == 'dev'
Provides-Extra: langchain
Requires-Dist: langchain-core<2.0.0,>=0.3.0; extra == 'langchain'
Description-Content-Type: text/markdown

# FailCore

**When your agent breaks, you don't need better prompts — you need to know what it actually did.**

FailCore is a **minimal execution tracing and failure analysis toolkit** for LLM agents.

It doesn't care how agents "think" — it cares about: **what was executed, why it failed, and can we replay it.**

> ⚠️ **Beta (0.1.2)** — core execution model, CLI, and trace format are stable; minor APIs may evolve.

---

## ✨ What's New in v0.1.2

- 🛡️ **Tool Metadata (Optional)** — Attach risk and side-effect hints to tools
- 🔒 **Improved Security Checks** — Path traversal detection and basic sandbox enforcement
- 📊 **Audit Reports** — HTML execution reports with failure and threat context
- 🎯 **Semantic Status** — Clear distinction: `BLOCKED` (prevented) vs `FAIL` (error)
- 🗄️ **Optional SQLite Ingestion** — Persist and query traces after execution

---

## Why FailCore?

**Traditional Agent Frameworks:**
- ❌ No visibility into which tool call failed
- ❌ Can't track agent permission violations
- ❌ LLM output drift (text instead of JSON) goes undetected
- ❌ Can't replay execution for root cause analysis

**FailCore Solution:**
- ✅ **Auto-tracing** — Every tool call logged to `.jsonl` trace
- ✅ **Security-aware execution** — Invalid or unsafe operations can be blocked before execution
- ✅ **Contract validation** — Detect output type drift (TEXT vs JSON)
- ✅ **Blackbox replay** — Audit execution without re-running LLM
- ✅ **Readable reports** — HTML reports for post-run inspection

---

## Quick Start

### Install (PyPI)

```bash
pip install failcore
```

> Pre-releases (TestPyPI):
> ```bash
> pip install -i https://test.pypi.org/simple \
>   --extra-index-url https://pypi.org/simple \
>   failcore
> ```

### Try the Demo

```bash
failcore sample
failcore show
```

### Minimal API

```python
from failcore import Session, presets

# Enable strict security mode (SSRF & Sandbox protection ON)
session = Session(validator=presets.fs_safe(strict=True))

@session.register
def write_file(path: str, content: str):
    with open(path, "w") as f:
        f.write(content)

# --- Simulation: LLM tries to attack ---
# 1. Path Traversal Attack -> BLOCKED
result = session.call("write_file", path="../etc/passwd", content="hack")
print(f"Status: {result.status}")  # Output: BLOCKED
print(f"Error: {result.error.message}") # Output: Path traversal detected

# 2. SSRF Attack -> BLOCKED
# (If you have network tools registered)
```

---

## View Execution Records

```bash
failcore list
failcore show                 # last run
failcore report               # generate HTML audit report
failcore replay run <trace>   # replay/mock
failcore replay diff <trace>
failcore report <trace>  # generate HTML report
```

---

## LangChain Integration (Optional)

```bash
pip install "failcore[langchain]"
```

```python
from failcore.adapters.langchain import create_langchain_toolkit

toolkit = create_langchain_toolkit(session)
# All agent tool calls are traced by FailCore
```

---

## Who Is This For?

- 🔧 Building production-grade agent systems
- 🐛 Debugging multi-step execution chains
- 🔒 Enforcing execution and permission boundaries
- 📊 Offline failure analysis and auditing

---

## License

Apache License 2.0 — see [LICENSE](LICENSE).
