Skip to main content

Official Python client for FoxNose Management and Flux APIs

Project description

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.

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

foxnose_sdk-0.5.0.tar.gz (76.5 kB view details)

Uploaded Source

Built Distribution

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

foxnose_sdk-0.5.0-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

File details

Details for the file foxnose_sdk-0.5.0.tar.gz.

File metadata

  • Download URL: foxnose_sdk-0.5.0.tar.gz
  • Upload date:
  • Size: 76.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for foxnose_sdk-0.5.0.tar.gz
Algorithm Hash digest
SHA256 edf2a2c919151b877fa25470e5dd4c3175859fc8ec142ff6566052a356e9bc7d
MD5 11e86fd129d0050e4043386f13933826
BLAKE2b-256 745be155d192f60027cb8e8167f3955ed4c64f627356d1c77568fad966561008

See more details on using hashes here.

File details

Details for the file foxnose_sdk-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: foxnose_sdk-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 37.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for foxnose_sdk-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a3dad1b976a7eb04567775c666f31a3979f2b8de61690f07a786dfa683fc023
MD5 792f14eb822ef026e8a39b8f56290c82
BLAKE2b-256 89f9688c2e21040c7c6fced76454bb2393294d617c4d60d12a3ca18f036c17af

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