evaldeck 0.1.0__py3-none-any.whl

evaldeck-0.1.0.dist-info/METADATA

@@ -0,0 +1,363 @@
+Metadata-Version: 2.4
+Name: evaldeck
+Version: 0.1.0
+Summary: The evaluation framework for AI agents. Pytest for agents.
+Project-URL: Homepage, https://github.com/tantra-run/evaldeck-py
+Project-URL: Documentation, https://tantra-run.github.io/evaldeck-py/
+Project-URL: Repository, https://github.com/tantra-run/evaldeck-py
+Project-URL: Issues, https://github.com/tantra-run/evaldeck-py/issues
+Author: Tantra Run Team
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,ai,autogen,crewai,evaluation,langchain,llm,testing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Requires-Dist: click>=8.0
+Requires-Dist: openinference-semantic-conventions>=0.1
+Requires-Dist: opentelemetry-sdk>=1.20
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Provides-Extra: all
+Requires-Dist: anthropic>=0.18; extra == 'all'
+Requires-Dist: openai>=1.0; extra == 'all'
+Provides-Extra: anthropic
+Requires-Dist: anthropic>=0.18; extra == 'anthropic'
+Provides-Extra: dev
+Requires-Dist: build>=1.0; extra == 'dev'
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1; extra == 'dev'
+Requires-Dist: twine>=5.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-autorefs>=0.5; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
+Requires-Dist: mkdocs>=1.5; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.24; extra == 'docs'
+Provides-Extra: openai
+Requires-Dist: openai>=1.0; extra == 'openai'
+Description-Content-Type: text/markdown
+
+# Evaldeck
+
+**The evaluation framework for AI agents. Pytest for agents.**
+
+[![PyPI version](https://badge.fury.io/py/evaldeck.svg)](https://badge.fury.io/py/evaldeck)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+
+---
+
+Evaldeck helps you answer one question: **"Is my agent actually working?"**
+
+Unlike LLM evaluation tools that focus on input→output scoring, Evaldeck evaluates the entire agent execution—how it reasons, which tools it selects, and whether it achieves the goal.
+
+## Why Evaldeck?
+
+- **Agent-native**: Evaluates multi-step traces, not just final outputs
+- **Framework-agnostic**: Works with LangChain, CrewAI, AutoGen, or custom agents
+- **Developer-friendly**: CLI-first, CI/CD ready, 5-minute setup
+- **Comprehensive metrics**: Tool correctness, step efficiency, plan adherence, and more
+- **Flexible grading**: Code-based, model-based (BYOK), or combine both
+
+## Installation
+
+```bash
+pip install evaldeck
+```
+
+With framework integrations:
+
+```bash
+pip install evaldeck[langchain]  # LangChain/LangGraph support
+pip install evaldeck[openai]     # OpenAI model graders
+pip install evaldeck[all]        # Everything
+```
+
+## Quick Start
+
+### 1. Initialize your project
+
+```bash
+evaldeck init
+```
+
+This creates:
+```
+evaldeck.yaml          # Configuration
+tests/evals/         # Test directory
+  example.yaml       # Example test case
+```
+
+### 2. Define test cases
+
+```yaml
+# tests/evals/booking.yaml
+name: book_flight_basic
+input: "Book me a flight from NYC to LA on March 15th"
+
+expected:
+  tools_called:
+    - search_flights
+    - book_flight
+  output_contains:
+    - "confirmation"
+    - "March 15"
+  max_steps: 5
+```
+
+### 3. Run evaluations
+
+```bash
+evaldeck run
+```
+
+Output:
+```
+Running 3 tests...
+
+  ✓ book_flight_basic (1.2s)
+  ✓ book_flight_roundtrip (2.1s)
+  ✗ book_flight_with_preferences (1.8s)
+    └─ FAIL at step 3: Wrong tool called
+       Expected: search_flights_with_filters
+       Got: search_flights
+
+Results: 2/3 passed (66.7%)
+```
+
+## Configuration
+
+```yaml
+# evaldeck.yaml
+version: 1
+
+agent:
+  module: my_agent
+  function: run
+
+test_dir: tests/evals
+
+defaults:
+  timeout: 30
+  retries: 2
+
+graders:
+  llm:
+    model: gpt-4o-mini
+    # Uses OPENAI_API_KEY from environment
+
+thresholds:
+  min_pass_rate: 0.9
+```
+
+## Test Case Format
+
+### Basic test case
+
+```yaml
+name: test_name
+input: "User message to the agent"
+
+expected:
+  # What tools should be called?
+  tools_called:
+    - tool_name_1
+    - tool_name_2
+
+  # What tools should NOT be called?
+  tools_not_called:
+    - dangerous_tool
+
+  # What should the output contain?
+  output_contains:
+    - "expected phrase"
+
+  # What should the output NOT contain?
+  output_not_contains:
+    - "error"
+
+  # Maximum steps allowed
+  max_steps: 10
+
+  # Must complete successfully?
+  task_completed: true
+```
+
+### Using model-based grading
+
+```yaml
+name: helpful_response
+input: "Explain quantum computing"
+
+graders:
+  - type: llm
+    prompt: |
+      Rate this response for helpfulness and accuracy.
+      Response: {{ output }}
+
+      Score from 1-5, where 5 is excellent.
+    threshold: 4
+```
+
+## Framework Integration
+
+### LangChain
+
+Copy the reference tracer from `examples/langchain_tracer.py` to your project:
+
+```python
+from langchain_tracer import EvaldeckTracer
+from langchain.agents import AgentExecutor
+
+tracer = EvaldeckTracer()
+agent = AgentExecutor(...)
+
+result = agent.invoke(
+    {"input": "Book a flight"},
+    config={"callbacks": [tracer]}
+)
+
+# Get trace for evaluation
+trace = tracer.get_trace()
+```
+
+### Manual trace construction
+
+```python
+from evaldeck import Trace, Step, Evaluator
+
+trace = Trace(
+    input="Book a flight from NYC to LA",
+    steps=[
+        Step(
+            type="tool_call",
+            tool_name="search_flights",
+            tool_args={"from": "NYC", "to": "LA"},
+            tool_result=[{"flight": "AA123", "price": 299}]
+        ),
+        Step(
+            type="tool_call",
+            tool_name="book_flight",
+            tool_args={"flight_id": "AA123"},
+            tool_result={"confirmation": "ABC123"}
+        ),
+    ],
+    output="Your flight AA123 is booked. Confirmation: ABC123",
+    status="success"
+)
+
+evaluator = Evaluator()
+result = evaluator.evaluate(trace, test_case)
+```
+
+## CI/CD Integration
+
+### GitHub Actions
+
+```yaml
+# .github/workflows/evaldeck.yaml
+name: Agent Evaluation
+
+on: [push, pull_request]
+
+jobs:
+  evaluate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - run: pip install evaldeck[all]
+
+      - run: evaldeck run --output junit --output-file results.xml
+        env:
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+
+      - uses: mikepenz/action-junit-report@v4
+        if: always()
+        with:
+          report_paths: results.xml
+```
+
+## Metrics
+
+| Metric | Description |
+|--------|-------------|
+| `task_completion` | Did the agent achieve the goal? |
+| `tool_correctness` | Were the right tools selected? |
+| `argument_correctness` | Were correct arguments passed to tools? |
+| `step_efficiency` | Did it complete without unnecessary steps? |
+| `tool_call_ordering` | Were tools called in the right sequence? |
+
+## Graders
+
+### Code-based (deterministic)
+
+```python
+from evaldeck.graders import ContainsGrader, ToolCalledGrader
+
+graders = [
+    ContainsGrader(values=["confirmation"]),
+    ToolCalledGrader(required=["book_flight"]),
+]
+```
+
+### Model-based (LLM-as-judge)
+
+```python
+from evaldeck.graders import LLMGrader
+
+grader = LLMGrader(
+    prompt="Did the agent complete the booking? Answer: pass or fail",
+    model="gpt-4o-mini",  # Uses your API key
+)
+```
+
+## Roadmap
+
+- [x] Core evaluation engine
+- [x] CLI interface
+- [x] LangChain integration
+- [ ] CrewAI integration
+- [ ] AutoGen integration
+- [ ] VS Code extension
+- [ ] Historical result tracking
+- [ ] Team dashboard (cloud)
+
+## Contributing
+
+We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+```bash
+# Setup development environment
+git clone https://github.com/tantra-run/evaldeck-py.git
+cd evaldeck
+pip install -e ".[dev]"
+pre-commit install
+
+# Run tests
+pytest
+
+# Run linting
+ruff check .
+mypy src/
+```
+
+## License
+
+Apache 2.0 - See [LICENSE](LICENSE) for details.

evaldeck-0.1.0.dist-info/RECORD

@@ -0,0 +1,21 @@
+evaldeck/__init__.py,sha256=SF9kMDGuf3UHMHrMeT8vBPzdLUtEqTjTAlRk6Fry9b0,1877
+evaldeck/cli.py,sha256=Khrl2CRkrYP18b1mG7sot82t-Glm4YAuNJxNkbRjuGU,10655
+evaldeck/config.py,sha256=V1o5q7nkek2GH1q-bCszxO5DqmrsrvuKDGvb2eZikvs,5847
+evaldeck/evaluator.py,sha256=kRdMGtIVJuMCJQWmeKvgjZrOLqAd9hq0kQVBJhUF9hM,19454
+evaldeck/results.py,sha256=gygFnuh2cZdZv5ygxDB-Lksv_9N5sAj2HFkEXRgTnqQ,6039
+evaldeck/test_case.py,sha256=Gqdy18W6S5KFd8Uy8gPd3LFvLaHbqr6ik1rt_s_LRNU,5009
+evaldeck/trace.py,sha256=erVrdJyfUilutM1z6NioIp8FVbeCh5XP6VhGtbwAClU,5787
+evaldeck/graders/__init__.py,sha256=TZtgQmdytdU-FbXpsZO_WUX7mJCH6rHtsahVB0kxpdI,784
+evaldeck/graders/base.py,sha256=CvLq_AQQfQzdrb4Hs1q6gcKB05e0qfWn31fxXir8T-k,4821
+evaldeck/graders/code.py,sha256=TmGz2FmEz5EQvLSYlRoYCeMsn5bTHqweIlSTm6Im-ko,15698
+evaldeck/graders/llm.py,sha256=nWMPacy-wTLKcE-PnIBdWyD1OHpXKNaTOyF1eicbdK0,11725
+evaldeck/integrations/__init__.py,sha256=IFyhW7gmnm3rRo27RRfL6Q2sGZ6lye7Abt9XqUql9eI,821
+evaldeck/integrations/opentelemetry.py,sha256=j518FXsD0pqMNF4TvO97elX9oDiK_VaKxXd243q8dLE,15164
+evaldeck/metrics/__init__.py,sha256=jXTIx5k9f1CjwS-9jc25YLeodhencoUOLfbP8qvcbbw,551
+evaldeck/metrics/base.py,sha256=ibUQNfbkQEXTX1x8SqmFWelWAF1DQ785LXP1KYIZWUk,1790
+evaldeck/metrics/builtin.py,sha256=ghdqeZRN51PhLeG8bGnPW2NNoPUAaeD05HtYlWw5yQM,5399
+evaldeck-0.1.0.dist-info/METADATA,sha256=BYvKY1IB_qZTHOWG1wez-2j3Xgw9Q3jncSKaR1D_02A,8596
+evaldeck-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+evaldeck-0.1.0.dist-info/entry_points.txt,sha256=wtyPiDMSTKf41ShIbQC5X8USDn68OybGecpTaMNaGts,47
+evaldeck-0.1.0.dist-info/licenses/LICENSE,sha256=sEp2tzjeTY9bP_jb1TWAGV4yvxNhVngHpJNglJkT9YA,10770
+evaldeck-0.1.0.dist-info/RECORD,,

evaldeck-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

evaldeck-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+evaldeck = evaldeck.cli:main

evaldeck-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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
+
+   Copyright 2024 Evaldeck Contributors
+
+   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.