Skip to main content

Official Python client and SDK for the LibreFang Agent OS

Project description

LibreFang Python SDK

Official Python client and SDK for the LibreFang Agent OS.

Installation

pip install librefang

Two Packages

This package provides two different interfaces:

1. REST API Client (librefang.client)

Control LibreFang remotely via its REST API.

from librefang import Client

client = Client("http://localhost:4545")

# Create an agent
agent = client.agents.create(template="assistant")
print(f"Agent created: {agent['id']}")

# Send a message
reply = client.agents.message(agent["id"], "Hello!")
print(reply)

# Stream a response
for event in client.agents.stream(agent["id"], "Tell me a story"):
    if event.get("type") == "text_delta":
        print(event["delta"], end="", flush=True)

2. Agent SDK (librefang.sdk)

Write Python agents that run inside LibreFang.

from librefang import Agent

agent = Agent()

@agent.on_message
def handle(message: str, context: dict) -> str:
    return f"You said: {message}"

agent.run()

Or use the simple input/output functions:

from librefang import read_input, respond

data = read_input()
result = f"Echo: {data['message']}"
respond(result)

Examples

See the examples/ directory for more examples:

Client Examples

  • client_basic.py - Basic REST API usage
  • client_streaming.py - Streaming responses

SDK Examples

  • echo_agent.py - Simple echo agent

Requirements

  • Python 3.8+

License

MIT

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

librefang_sdk-2026.4.2b8.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

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

librefang_sdk-2026.4.2b8-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.4.2b8.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.4.2b8.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for librefang_sdk-2026.4.2b8.tar.gz
Algorithm Hash digest
SHA256 011a77095aa9c3acfa7d05155b4c675e2363a043c293995f72bcda8ab7dbbd89
MD5 01106cc40ca421024f4b7ebe0d2d8223
BLAKE2b-256 82ebca5e942af8e2e9d59bc77c349e6791a2e9fcf37437d9b9954a7f8b198a52

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.4.2b8-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.4.2b8-py3-none-any.whl
Algorithm Hash digest
SHA256 083b515f5c76f5706b2d2ad3669124914fb32afc25a535840d35eba5bf7b2886
MD5 c79a0bdb651af97eaaffb2cafd7e4106
BLAKE2b-256 4439a0341ee9371f040ff94da8d3f2df6e3925c874ff8be7cccdfdd1839fab68

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