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.5.25b14.tar.gz (471.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.5.25b14-py3-none-any.whl (320.6 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.5.25b14.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.5.25b14.tar.gz
  • Upload date:
  • Size: 471.4 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.5.25b14.tar.gz
Algorithm Hash digest
SHA256 425f588f7338f96a2d8534d3923cab094ae171f81f2736204c8731df0191869b
MD5 05c5a89a07d8cc3cb9b7aae02105f87e
BLAKE2b-256 ef8e4d893a9fa0a7a9b96ad8654df6d9739d47b588ae9c588b788093e1c4c8cc

See more details on using hashes here.

Provenance

The following attestation bundles were made for librefang_sdk-2026.5.25b14.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.5.25b14-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.5.25b14-py3-none-any.whl
Algorithm Hash digest
SHA256 482bea335223648577f43e2523c61f8bb07c6d1f3fe189dd286174f3b8bfddaf
MD5 50ffd80c41980f3242b257d4c47cd96a
BLAKE2b-256 6454ba8c6335e1b2733dad1cf6ff51e15ecc3d2cbeb72a9002c7d79ec79fefc9

See more details on using hashes here.

Provenance

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