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

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.3.2201.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.3.2201.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.2201.tar.gz
Algorithm Hash digest
SHA256 bc81865a4a445e1d0c05fb8ba222ae384124ecce7c0da25f2043b9543a00ec6e
MD5 4b975526b18a3f8fed40ebc78cb09d47
BLAKE2b-256 c11043ff70a16c085d7bfece2d7170e3fceb2ddc01ffe61a7cbc199c326c7d62

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.3.2201-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.3.2201-py3-none-any.whl
Algorithm Hash digest
SHA256 e62b002aa56d70f971a88c42d5bb3e726a4dbd37697c233c247002e58caeda14
MD5 ea44fa324a924d6846c7c0e6f6c042fa
BLAKE2b-256 23a6d56df1d8e7de442b9167fa30cd8cce4e3098c9c70b347211f467b07c3431

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