Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

FoxNoseTech/foxnose-python

Repository files navigation

FoxNose Python SDK

PyPI version Python versions CI codecov Docs License

FoxNose is a managed knowledge layer for RAG and AI agents — auto-embeddings, hybrid search, and zero ETL pipelines to maintain.

This is the official Python SDK for FoxNose Management and Flux APIs.

Features

  • Type-safe clients - Full type hints and Pydantic models
  • Sync and async - Both synchronous and asynchronous clients
  • Automatic retries - Configurable retry with exponential backoff
  • JWT authentication - Built-in token refresh support
  • Flux introspection - Discover routes and live schema via /_router and /_schema

Documentation

SDK Documentation: foxnose-python.readthedocs.io

FoxNose Platform:

Installation

pip install foxnose-sdk

Quick Start

To get started, you'll need a FoxNose account. Create one here.

from foxnose_sdk.management import ManagementClient
from foxnose_sdk.auth import JWTAuth
client = ManagementClient(
 base_url="https://api.foxnose.net",
 environment_key="your-environment-key",
 auth=JWTAuth.from_static_token("YOUR_ACCESS_TOKEN"),
)
# List folders
folders = client.list_folders()
for folder in folders.results:
 print(f"{folder.name} ({folder.key})")
client.close()

Async Client

from foxnose_sdk.management import AsyncManagementClient
async def main():
 client = AsyncManagementClient(
 base_url="https://api.foxnose.net",
 environment_key="your-environment-key",
 auth=JWTAuth.from_static_token("YOUR_ACCESS_TOKEN"),
 )
 folders = await client.list_folders()
 await client.aclose()

Flux Client

from foxnose_sdk.flux import FluxClient
from foxnose_sdk.auth import SimpleKeyAuth
client = FluxClient(
 base_url="https://<env_key>.fxns.io",
 api_prefix="v1",
 auth=SimpleKeyAuth("PUBLIC_KEY", "SECRET_KEY"),
)
resources = client.list_resources("blog-posts")
client.close()

Development

# Install with dev dependencies
pip install -e .[test,docs]
# Run tests
pytest
# Run tests with coverage
pytest --cov=foxnose_sdk --cov-report=term-missing
# Build docs
mkdocs serve

License

Apache 2.0 - see LICENSE for details.

AltStyle によって変換されたページ (->オリジナル) /