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.10b17.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.4.10b17-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.4.10b17.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.4.10b17.tar.gz
  • Upload date:
  • Size: 7.4 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.10b17.tar.gz
Algorithm Hash digest
SHA256 01030d941c84e940c9023ce0fd62682fae674d23988af35a75d251e5cb94a7ce
MD5 283ebdb05afc0c0f0202e84f4aa0039f
BLAKE2b-256 c03cca0bfcc404b1a3c099ed9616994ae1cdf7f248040d8d34e03e025ca9417b

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.4.10b17-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.4.10b17-py3-none-any.whl
Algorithm Hash digest
SHA256 c5e540be9215e70269947d1b5efc8f0c413a8c388cc6fe7d6f9633192721c1e5
MD5 8ec1c865eaefc71f3a74707e1f10eae5
BLAKE2b-256 515df88d41e348ea670c9653180c8e64de6b7bd9d9de2fb180889a87a655c806

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