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.14b20.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.14b20-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.4.14b20.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.4.14b20.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.14b20.tar.gz
Algorithm Hash digest
SHA256 14856f0d084739f8bb4118fc04eb22d3c69d5d8ed2ca0750f75a82b3a5cf177d
MD5 e36a07c6cbeac8502bf20c889abba2fa
BLAKE2b-256 96e1df369456e114d9f367f5a09d5b3937badb39c3b183ed62a9b29d7d70bdec

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.4.14b20-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.4.14b20-py3-none-any.whl
Algorithm Hash digest
SHA256 5a7c39bc61d62c0bda075e7c161d76b5f0fcb6dd9ab146c7838aa76875544aec
MD5 c199df4db3155ee397efecd257915d64
BLAKE2b-256 4500f8772a6f81ffaeb2ee8c1fedf066080cf55fc38c5354a91989308eb6845f

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