docs: fix API signature, add pydantic dep, fix URLs#9
Merged
Conversation
Old URL docs.capisc.io/integrations/langchain returns 404. Updated to actual published path at /how-to/integrations/langchain/. Fixes: DOCS_REMEDIATION_PLAN P2-4
- CapiscioTool uses keyword-only args (*, identity, config, mode, api_key) not positional (tool, mode, identity, api_key). Fixed API reference. - Added pydantic>=2.0 to dependencies (directly imported in guard.py). - Added note that langgraph is a separate install for LCEL example. - Fixed dead CONTRIBUTING.md link (file doesn't exist). Fixes: DOCS_REMEDIATION_PLAN P2-11
There was a problem hiding this comment.
Pull request overview
This PR corrects published package/docs metadata and README guidance so users get the right documentation links and accurate API/dependency information for langchain-capiscio.
Changes:
- Add an explicit
pydantic>=2.0runtime dependency (directly imported bylangchain_capiscio/guard.py). - Fix the PyPI
DocumentationURL inpyproject.toml. - Update README: clarify LangGraph as a separate install, correct
CapiscioToolsignature, and replace a dead contributing link.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
pyproject.toml |
Adds missing pydantic dependency and updates the project Documentation URL. |
README.md |
Updates usage/docs text (LangGraph prereq note, CapiscioTool signature, contributing guidance). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
253
to
+255
| ### Tool Enforcement | ||
|
|
||
| - `CapiscioTool(tool, mode, identity, api_key)` — Wrap a LangChain `Tool` with trust enforcement | ||
| - `CapiscioTool(tool, *, identity=None, config=None, mode="block", api_key=None)` — Wrap a LangChain `Tool` with trust enforcement |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes documentation URL, CapiscioTool API signature, missing pydantic dependency, and langgraph prerequisite note.
Issues Fixed
Changes
PyPI URL (commit 1)
DocumentationURL in[project.urls]to correct docs pageREADME & Dependencies (commit 2)
CapiscioToolsignature: uses keyword-only args(tool, *, identity=None, config=None, mode="block", api_key=None)not positional(tool, mode, identity, api_key)pydantic>=2.0to dependencies (directly imported in guard.py but was only transitively available)langgraphis a separate install for the LCEL composition exampleCONTRIBUTING.mdlink (file doesn't exist)