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

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.4.19b25.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.4.19b25.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.19b25.tar.gz
Algorithm Hash digest
SHA256 0b7633c1530f34183a92fd3ace11afa13b0bf4e21e5467d10c6d006b99e90e78
MD5 6231b3b45a9fa7c8cd9399454db8f031
BLAKE2b-256 1bb8588ee3e8952232b4b6c3a4e5c4b011fa066d2226aa85a8c37f2d7c42c3f8

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.4.19b25-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.4.19b25-py3-none-any.whl
Algorithm Hash digest
SHA256 e7780c6d1cce34ade3f23b740db0dc96a393c4a96ebbb087a613bd2fabfa1a62
MD5 9d0a19b8bf26959db9708df472962f45
BLAKE2b-256 d8cde28987298736d07336fe119451f3a13bec6575eeb75e5970b74170070399

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