Skip to main content

afs-connector-sdk

Crawl a source and ingest its documents into agentic-fs. Ships the fs-crawler CLI plus Local FS and S3 connectors.

pip install afs-connector-sdk          # Local FS connector + unauthenticated/bearer APIs
pip install "afs-connector-sdk[aws]"   # adds the S3 connector + SigV4 signing for AWS_IAM Function URLs

CLI

# Crawl a local folder into a dev server
fs-crawler --connector local --source ./docs \
  --api-url http://localhost:8080 --namespace docs

# Crawl an S3 prefix into the deployed (AWS_IAM) Function URL
fs-crawler --connector s3 --source s3://my-bucket/reports/ \
  --api-url "$FUNCTION_URL" --namespace reports --auth sigv4 --region us-east-1

# Mirror exactly (also delete docs no longer at the source)
fs-crawler --connector local --source ./docs --api-url "$URL" --namespace docs --prune

Re-runs are cheap and idempotent: a document is skipped unless its content checksum differs from what agentic-fs already has, so nothing is re-extracted needlessly.

Library

from afs_connector_sdk import IngestClient, SyncEngine, SigV4Signer, build_connector

connector = build_connector("local", "./docs")
async with IngestClient(api_url, signer=SigV4Signer(region="us-east-1")) as client:
    report = await SyncEngine(client).sync(connector, namespace="docs")

Writing a connector

Implement afs_core.contracts.Connector (discover() → SourceItems, fetch(item) → bytes), certify it against afs_core.testing.ConnectorConformance, and register an afs.connectors entry point. Source-side auth lives in your connector; the SDK handles everything else. See the connector swap guide.

Metadata

Release files for afs-connector-sdk 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for afs-connector-sdk 1.0.1
File Size Uploaded Provenance Actions
afs_connector_sdk-1.0.1.tar.gz 18.3 kB Without provenance Details for afs_connector_sdk-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for afs-connector-sdk 1.0.1
File Interpreter ABI Platform Actions
afs_connector_sdk-1.0.1-py3-none-any.whl Python 3 none any Details for afs_connector_sdk-1.0.1-py3-none-any.whl

Total release size: 35.9 kB

Release files / afs_connector_sdk-1.0.1.tar.gz

Download URL afs_connector_sdk-1.0.1.tar.gz
Size 18.3 kB
Tags Source
SHA-256 checksum
How to use checksums
2def7826486a3bb2ecb4cf7aa8fac728743382b9578a7d391cb21e117e56d533
BLAKE2b-256 checksum
How to use checksums
b4a0fc675b2eca0a0eb33152ac5f795512cf93b2bee6daea7599066af7572964
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / afs_connector_sdk-1.0.1-py3-none-any.whl

Download URL afs_connector_sdk-1.0.1-py3-none-any.whl
Size 17.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b27ad98ca020e1c0116fec97fbf9a848436304c33f4be5ee21e3236d095e757f
BLAKE2b-256 checksum
How to use checksums
64f8cddcc64e2f79e75a22750e6a3d9ec1b41245842b9ecc372f6bc89ea00ef5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for afs-connector-sdk 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page