skout-scan 0.1.0__tar.gz

skout_scan-0.1.0/.gitignore

@@ -0,0 +1,64 @@
+# Python bytecode
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Packaging
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# Testing
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+.nox/
+
+# Type checking / linting
+.mypy_cache/
+.ruff_cache/
+.pyright/
+
+# IDEs
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# macOS
+.DS_Store
+
+# Environment variables / secrets
+.env
+.env.*
+!.env.example
+
+# API keys / credentials
+*.pem
+*.key
+credentials.json
+secrets.json
+
+# AgentGuard local state
+.agentguard/
+
+# Logs
+*.log
+logs/
+
+# Temporary files
+tmp/
+temp/
+.cache/
+
+# Jupyter
+.ipynb_checkpoints/

skout_scan-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

skout_scan-0.1.0/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.4
+Name: skout-scan
+Version: 0.1.0
+Summary: Skout Scan finds potentially untested behaviors in AI-agent repositories.
+Project-URL: Homepage, https://github.com/skouthq/skout-scan
+Project-URL: Documentation, https://github.com/skouthq/skout-scan#readme
+Project-URL: Repository, https://github.com/skouthq/skout-scan
+Project-URL: Issues, https://github.com/skouthq/skout-scan/issues
+Author: Puja Kamath
+Maintainer: Puja Kamath
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agent-testing,agents,ai,cli,evals,evaluation,static-analysis,testing
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: pydantic<3.0,>=2.8
+Requires-Dist: rich<15.0,>=13.7
+Requires-Dist: typer<1.0,>=0.12
+Provides-Extra: dev
+Requires-Dist: build<2.0,>=1.2; extra == 'dev'
+Requires-Dist: mypy<2.0,>=1.11; extra == 'dev'
+Requires-Dist: pytest-cov<7.0,>=5.0; extra == 'dev'
+Requires-Dist: pytest<9.0,>=8.3; extra == 'dev'
+Requires-Dist: ruff<1.0,>=0.6; extra == 'dev'
+Requires-Dist: twine<7.0,>=6.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Skout Scan
+
+**Find what your AI agent evals aren't testing.**
+
+Skout Scan statically scans your agent code and eval suite to surface
+high-confidence behaviors that may be insufficiently tested.
+
+**Local-first. No code execution. No source upload. No API key required.**
+
+## Try Skout Scan
+
+### 1. Install
+
+Skout Scan requires Python 3.12 or newer.
+
+```bash
+pip install skout-scan
+```
+
+### 2. Scan your agent repository
+
+```bash
+cd your-agent-repo
+skout scan .
+```
+
+Skout Scan discovers repository artifacts, extracts eval scenarios and
+deterministic agent behaviors, matches behaviors against existing eval evidence,
+and surfaces selected high-confidence potential gaps.
+
+### 3. Review the findings
+
+```bash
+skout review
+```
+
+The interactive review shows the source, evidence, coverage assessment, and a
+suggested eval for each high-confidence potential gap. Classify each finding as:
+
+- `add_eval` — you intend to add or modify an eval
+- `valid_later` — the gap is valid but is not a current priority
+- `already_covered` — adequate coverage already exists
+- `not_relevant` — the behavior does not need an eval
+- `suppressed` — hide the finding from normal output
+
+### 4. See your validation metrics
+
+```bash
+skout metrics --repository .
+skout metrics --repository . --json
+```
+
+The JSON form provides a machine-readable export that you can share with the
+Skout Scan team during V0 validation.
+
+### 5. Give feedback
+
+We're validating Skout Scan with engineers building real AI agents. If you try
+it, we'd really value 2 minutes of feedback:
+
+[Share feedback](https://forms.gle/EfTMt3dyhZnCTphN6)
+
+Generate the JSON to paste into the feedback form with:
+
+```bash
+skout metrics --repository . --json
+```
+
+Skout Scan does not automatically upload metrics, source code, or repository
+contents.
+
+## What Skout Scan finds
+
+A finding is an explainable potential gap, for example:
+
+```text
+Potential eval gap
+
+Tool:
+create_jira_ticket
+
+Why flagged:
+Skout Scan found the tool behavior but no eval that both exercises the behavior
+and verifies its expected outcome.
+
+Suggested test:
+Invoke create_jira_ticket with valid inputs and verify the expected mutation.
+```
+
+Each detected behavior receives one of these assessments:
+
+- `covered` — an eval meaningfully exercises the behavior and verifies its
+  expected outcome or invariant
+- `partially_covered` — an eval exercises the functionality, but does not fully
+  verify a relevant condition, branch, failure path, or expected outcome
+- `potentially_uncovered` — no discovered eval appears to materially exercise
+  and verify the behavior
+
+Skout Scan selects high-confidence actionable findings from these assessments.
+It does not turn every raw assessment into a finding or calculate an overall
+behavioral coverage percentage.
+
+## Supported patterns
+
+V0 extracts eval evidence from:
+
+- pytest `test_*` functions and test methods in `Test*` classes
+- direct `assert` statements and `pytest.raises`
+- statically resolvable calls and literal arguments
+- JSONL eval scenarios with an `input`, optional `expected`, and optional
+  metadata such as a name or tool list
+
+V0 extracts deterministic behaviors from:
+
+- functions decorated with `@tool`, qualified `@*.tool`, or `@function_tool`
+- local functions registered through literal tool collections, `tools=[...]`,
+  or `bind_tools([...])`
+- explicit raised exceptions and explicit failure returns
+- deterministic conditional branches with visible return, raise, escalation,
+  or handoff outcomes
+- supported LangGraph `add_edge` transitions and literal
+  `add_conditional_edges` routes on statically assigned `StateGraph` instances
+
+Calls through `.invoke`, `.ainvoke`, and `.coroutine` are recognized as tool
+invocations only when the receiver is already known statically as a tool. The
+wrapper call alone does not prove that an expected outcome or failure path was
+verified.
+
+## How it works
+
+```text
+Repository
+↓
+Discover artifacts
+↓
+Extract eval scenarios
+↓
+Extract deterministic agent behaviors
+↓
+Match behaviors to eval evidence
+↓
+Surface high-confidence potential gaps
+↓
+Engineer reviews findings
+↓
+Persist local lifecycle and feedback
+```
+
+Analysis and matching are static and deterministic. Skout Scan never imports or
+executes Python from the target repository. It stores finding history, review
+feedback, and scan history in `.agentguard/agentguard.db` within the scanned
+repository.
+
+Behavior and finding IDs are designed to survive formatting, whitespace, and
+line movement where possible. On later complete scans, Skout Scan can observe
+when a new or modified eval covers a previous finding and record that finding as
+resolved. Review choices and lifecycle history persist locally across scans.
+
+## Limitations
+
+- Static analysis is intentionally conservative. Indirect calls, fixture
+  indirection, aliases, and wrappers outside the supported patterns may be
+  missed.
+- Dynamically constructed tool, agent, or workflow registration may not be
+  discovered.
+- Dynamic pytest parametrization has limited support.
+- Prompt files are discovered, but natural-language prompt obligations are not
+  extracted as behaviors in V0.
+- File moves, symbol renames, and major restructuring may change stable IDs.
+- V0 does not use semantic, embedding, or LLM-based matching.
+- V0 does not analyze production traces.
+- Skout Scan does not calculate an overall numeric behavioral coverage
+  percentage.
+- Findings are potential testing gaps. They do not certify that an agent is
+  safe, unsafe, production-ready, or inadequately tested.
+
+## Configuration
+
+Configuration is optional. When present, `agentguard.toml` must be in the root
+of the repository being scanned.
+
+```toml
+include = ["**/*.py", "**/*.jsonl"]
+exclude = ["**/.venv/**", "**/.agentguard/**", "**/build/**", "**/dist/**"]
+```
+
+`include` selects candidate artifacts and `exclude` removes matching paths;
+exclusions take precedence. Patterns match POSIX-style paths relative to the
+repository root and support recursive `**` segments.
+
+Without a configuration file, Skout Scan includes Python, text, Markdown, and
+JSONL files and excludes common Git, virtual-environment, dependency, cache,
+build, distribution, and local-state directories. Symbolic links are not
+followed.
+
+## Development
+
+Create a Python 3.12 environment and install the project with development tools:
+
+```bash
+python3.12 -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+The public distribution and command are `skout-scan` and `skout`. The current
+internal Python package remains `agentguard` under `src/agentguard/`.
+
+Run the contributor checks:
+
+```bash
+pytest
+ruff check .
+ruff format --check .
+mypy src/agentguard
+```
+
+Validate release artifacts with:
+
+```bash
+python -m build
+python -m twine check dist/*
+```
+
+Release maintainers should follow the
+[release guide](https://github.com/skouthq/skout-scan/blob/main/docs/releasing.md).