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.24b23.tar.gz (475.0 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.24b23-py3-none-any.whl (323.4 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.6.24b23.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.6.24b23.tar.gz
  • Upload date:
  • Size: 475.0 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.24b23.tar.gz
Algorithm Hash digest
SHA256 b323144825d19c44b33a094870be6f5f143a6d96e9da42d0da1154ba5a26dced
MD5 cee7b57d57fb4c1261c06682f8de68b3
BLAKE2b-256 638cade1d417d0cd55c56c939efb51135d575f66a92b630bcd2f48588e367deb

See more details on using hashes here.

Provenance

The following attestation bundles were made for librefang_sdk-2026.6.24b23.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.24b23-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.6.24b23-py3-none-any.whl
Algorithm Hash digest
SHA256 8176d7fe3b3658f9ff4c998dd9e60258d5da47ab44b45d7e8dc8aba27083887a
MD5 fde19cd02f45d9169bf5dcb8ade57110
BLAKE2b-256 e76cdcf3cd5bbe5ee8a8cde7bbb7a7f77de16aecc8795af7faae7ea910170b6d

See more details on using hashes here.

Provenance

The following attestation bundles were made for librefang_sdk-2026.6.24b23-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