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.27b6.tar.gz (11.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.4.27b6-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.4.27b6.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.4.27b6.tar.gz
  • Upload date:
  • Size: 11.4 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.27b6.tar.gz
Algorithm Hash digest
SHA256 9f045dddd03afbebfe0671ea616bac42bdca7931332e6cf92935af71ee339968
MD5 aeb865cb315037981080585c1fcc5807
BLAKE2b-256 881ab6e28f58458112ae4412386758ceb6ccbd9a792e08faaa029bef8b5d96bd

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.4.27b6-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.4.27b6-py3-none-any.whl
Algorithm Hash digest
SHA256 82f97aac3c7c9d7b6f4e10c1ef1561700f4f075b439819d35b1b46fc8dbefef4
MD5 b39404d411827bbed778f9f3a33abc17
BLAKE2b-256 6e9cce0558a00b24e0a5c712b4accc0919ce5f1d6d00fec39191665352ca8a49

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