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

Uploaded Python 3

File details

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

File metadata

  • Download URL: librefang_sdk-2026.3.25rc2.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.25rc2.tar.gz
Algorithm Hash digest
SHA256 829bfb8cc7048cc76378572a493aad32ec5a4e5d3129b4cf39fbde748737859e
MD5 70ffa75bd7ff4ef1eb97506b42eeae1a
BLAKE2b-256 67ae794940d61018ea9f614442fa2ef042caee6750e65b8c6c4ecf381f6cf89b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for librefang_sdk-2026.3.25rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 f706e9b98d582031dcc4f2692934759d4e6017dbdd29642e133eda6abb015803
MD5 8f2ee6a15168a0a7de78bffc1488b0a2
BLAKE2b-256 e128b088d34a22b6c1f403f3986c7b20a71c44582250a736e2dd9b877a1153ac

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