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.2314rc1.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.3.2314rc1-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.3.2314rc1.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.3.2314rc1.tar.gz
  • Upload date:
  • Size: 7.4 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.2314rc1.tar.gz
Algorithm Hash digest
SHA256 e079e54096dd172055746cf63531490058c55408f476f83b80f249fd5d3692f2
MD5 86069c901f28834801af5cbc411c5de3
BLAKE2b-256 cd1abe759b96048067a7821a351a4a37c4c7cd5fda4889db014e3d573709d329

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.3.2314rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.3.2314rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 49c45ebd532e3cc819957c28d4ddee7a1e9832c972969d6a2e900ce4805e2e96
MD5 b3dedfe0326b4413390ddb76ea7c3456
BLAKE2b-256 8d170af458d92e2dc25826c5ed3f81a3582ca74384d6f8e4e0a6dc6a55282375

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