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

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.4.18b23.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.4.18b23.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.18b23.tar.gz
Algorithm Hash digest
SHA256 1a2bf0cad21a789e9376351b27163b1a1fd17a01f2c3cd2ae4482a1d2f05b6d8
MD5 622742df723888778243a629f4e46424
BLAKE2b-256 44dfe28d22e50a259606429b5d65da23736bc04e6b7e94ccdcadcac9f7a5591c

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.4.18b23-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.4.18b23-py3-none-any.whl
Algorithm Hash digest
SHA256 8014b53526683440f54030ec75738982af2557e554108e50a3ef23bdbcb66baa
MD5 5a0c7349a9398c4ae2c5392e6a91f2f6
BLAKE2b-256 08d191e824e6b408705607108de4eb6d4e716cdd6a80a3280e50b0c1e5c85d14

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