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

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.4.21b1.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.4.21b1.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.21b1.tar.gz
Algorithm Hash digest
SHA256 d7f093196c47f5c32c4d5a36b59eb6ade75f60d1a0dcfb0d6e9be81d4e68563d
MD5 ae11218cc201d345a470ec5667762ad5
BLAKE2b-256 b292dfb09d668ffc5000361c13d464cf90934c63d8df350aa4c8cfe276de44a6

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.4.21b1-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.4.21b1-py3-none-any.whl
Algorithm Hash digest
SHA256 0323e16845d259f77931afbaf5277f3240e2af568936bd9c8df2e2a32a3246d1
MD5 f3ec2d105606a4518b870b2cd13a2862
BLAKE2b-256 e642650c2d495be6379c379270ae7ca56dd6943567aa4b2c82f2330b5825cc5e

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