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

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.3.30b3.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.3.30b3.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.30b3.tar.gz
Algorithm Hash digest
SHA256 18b233fba7f6d354aa4e22e4cd0bac5aa9e2e58491226b0eedcbffb7226b60a0
MD5 c77c8c9ba5bc6b7bc38f3aecfa0350dc
BLAKE2b-256 3a63dbb1191294a4fd5aa32016a5d2ab948d2b4283d55ff7aee5eac54296c22e

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.3.30b3-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.3.30b3-py3-none-any.whl
Algorithm Hash digest
SHA256 6b7387a780c39af0a1785473c3013dd0049a64e3764165a4e5695c00012aace3
MD5 8b2a3fb022aa2ed75ac75479c17cc8b4
BLAKE2b-256 d9d90f777ce32e60d84b1fd55fdcba5caba75d22b2ed2404bad764109297e47e

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