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.6.22b22.tar.gz (474.9 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.6.22b22-py3-none-any.whl (323.4 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.6.22b22.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.6.22b22.tar.gz
  • Upload date:
  • Size: 474.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for librefang_sdk-2026.6.22b22.tar.gz
Algorithm Hash digest
SHA256 f418f77980f449835d5d3694df24a78f31d53eb94b3f86bd43e625f49aae39c9
MD5 99ee780cccee93bb13562c76ec4ee151
BLAKE2b-256 2ef7edc26e53884e8b870dfafc7e720f0dcb91d37370b6b059a40b4e77e9b1e2

See more details on using hashes here.

Provenance

The following attestation bundles were made for librefang_sdk-2026.6.22b22.tar.gz:

Publisher: release.yml on librefang/librefang

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file librefang_sdk-2026.6.22b22-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.6.22b22-py3-none-any.whl
Algorithm Hash digest
SHA256 397094645386a8f5aaf844b68e3ea1f58f183e5e4933d71d82a78a0238ec86a2
MD5 73ef80e2b39588454c9d8646c9bc8c92
BLAKE2b-256 d62a4db939ae9ba30bbff51b7f78c26f04d7b017cb3c333b8b29af3c2ac28705

See more details on using hashes here.

Provenance

The following attestation bundles were made for librefang_sdk-2026.6.22b22-py3-none-any.whl:

Publisher: release.yml on librefang/librefang

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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