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.22b2.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.22b2-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.4.22b2.tar.gz.

File metadata

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

File hashes

Hashes for librefang_sdk-2026.4.22b2.tar.gz
Algorithm Hash digest
SHA256 174eae71d657f365c2ce07d820fe7f8bc7b3f16b4de9295f3daba7606cd196ad
MD5 e84dfa61017cffdb365bf4cd7a827692
BLAKE2b-256 f68ecd852e155849067693899f4615b7fcec369ba476cc149690b0bb0b3231c1

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.4.22b2-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.4.22b2-py3-none-any.whl
Algorithm Hash digest
SHA256 3c7141469b915ae85d521168f1b611ffb9d61c6a7d13b276ad2a916c2423d1f6
MD5 a1a574eac668fa6d67bf71af3e1922ea
BLAKE2b-256 a2926b8d0e59272fec87ee2b234a348503559ccece50e09274bdad150894822d

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