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.3.25rc1.tar.gz (7.4 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.3.25rc1-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.3.25rc1.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.3.25rc1.tar.gz
  • Upload date:
  • Size: 7.4 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.3.25rc1.tar.gz
Algorithm Hash digest
SHA256 8f0ec9b604b9d8e00c3b8a30ed56de4f4f60f7b288b3267fabdb43100f365297
MD5 9a9e6c854c42df0a4e7f841baeb55067
BLAKE2b-256 9f85969e425d1afa795ccedef9cf68f1c70ed283552a69262939652327e215cc

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.3.25rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.3.25rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 cec02c69c797881a1d045c044b411531f72e74fd6d19d0756dfc29ada88221b9
MD5 4e577688e4bdf6f3d25ff2354470a817
BLAKE2b-256 e5c2b220227e87925db5836105f131528626060d4740dbb38672adb025542106

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