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

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.4.23b4.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.4.23b4.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.23b4.tar.gz
Algorithm Hash digest
SHA256 5b858aded1c352a460e63523817f2ac8888f92479c55f10d06db5d002ce4643f
MD5 7af0d55db9be7e84cefc2fe41c5ab26e
BLAKE2b-256 ec9ff645e90271499628874374b7e3b87081f5cd265865cd8098b9bacdb14893

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.4.23b4-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.4.23b4-py3-none-any.whl
Algorithm Hash digest
SHA256 7c05082f0d60245a73ea1bc25d506fb1c55d4e0a146a3fb36e32ab4a968c403b
MD5 b0d638ff6091ff7cfa18fb7f7ab0af88
BLAKE2b-256 4281e8935fb30497751600603ff5f3472f36444b63029a626c6de8cde82cfeae

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