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

Uploaded Python 3

File details

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

File metadata

  • Download URL: librefang_sdk-2026.3.2407rc1.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.2407rc1.tar.gz
Algorithm Hash digest
SHA256 a4c948a3da07e8a8b755748e092995144b0f91e2cd6a214145ba00682964b30c
MD5 3cc0341aeafeccfa359debaa4709885a
BLAKE2b-256 8771410952e406ace8086cffc7aab9fb7819ed48bd7caa24e1164735d3082ab9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for librefang_sdk-2026.3.2407rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 dfae1718b08b1e67e326c8019d772131a5e733da89a5c54b86f332e425c57bfd
MD5 6a3dc5da70af836c82cbb5f5ac961541
BLAKE2b-256 495c7804dbc6d73187342f6052c62730c87fa93211a030763cb95c453684d9f1

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