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.31b4.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.3.31b4-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.3.31b4.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.3.31b4.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.3.31b4.tar.gz
Algorithm Hash digest
SHA256 fe956f9d46a37abe93a26bb12819359adb3da1df4e963b3e1f1858beb1b132df
MD5 2c511507d1cd0fe19c7742d411f8fb0c
BLAKE2b-256 41025c7a010e7fcebbecd49b6091226277472c80b253ed4d5328a52b2390ade5

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.3.31b4-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.3.31b4-py3-none-any.whl
Algorithm Hash digest
SHA256 19f80ddd1d59207869635af8d9c6dfb760ce0bb72f1fb9bb10800b3cd0b1f4c7
MD5 a671a989d92e1c66cf6120683d83a9a2
BLAKE2b-256 dd1feb2cfe3e68626a44b46a6242c84f5be1cc00c2ecf73c9b45420573492473

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