Skip to main content

agentic-fs connector SDK: crawl a source and ingest into agentic-fs. Ships the fs-crawler CLI plus Local FS and S3 connectors.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

afs_connector_sdk-1.0.0.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

afs_connector_sdk-1.0.0-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file afs_connector_sdk-1.0.0.tar.gz.

File metadata

  • Download URL: afs_connector_sdk-1.0.0.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using 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}

File hashes

Hashes for afs_connector_sdk-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a87721020017dd8fb9c2734232f5882376d9a9ea607afb275be21c64c89ea9fc
MD5 5b28c59d7e82dd552e15cf694a35e4d7
BLAKE2b-256 13ced013377f794d7caaf7b3ed08fe45e9bb125aea152749a646b436f53b0c1c

See more details on using hashes here.

File details

Details for the file afs_connector_sdk-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: afs_connector_sdk-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using 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}

File hashes

Hashes for afs_connector_sdk-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 46824e4cdd85632787ebdc956e27e7c689eab6201640a1e1fd42ba3a22e1bfc9
MD5 6507a9e2966a5ce90ae1a70a52c9f038
BLAKE2b-256 5103818aa92ccc1ab7cdaa617f43dc3e03e7a8e285053761612a749d9ca37445

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page