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.29.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.29-py3-none-any.whl (323.4 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.6.29.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.6.29.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.29.tar.gz
Algorithm Hash digest
SHA256 7f22d33660831e9a3eb888e66f4e68f4612380d3206b6edb13d4e122ae8137df
MD5 f94a3134e34befaf11ddddef47b89a3f
BLAKE2b-256 2976aff55a8975ac921cda36366cc64e0fbbe3887e85d63318d1be4ad4f03c06

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for librefang_sdk-2026.6.29-py3-none-any.whl
Algorithm Hash digest
SHA256 2e88cb33e616394eaebd12709f5b919770954c1487dad576f10cc8685c7f6934
MD5 5c46d18031e0c82f6f2e80f5703ed312
BLAKE2b-256 3d8a2d405de3f3883cf4d6e8da1d59a8fb783d6b5398cfddffb130e38eb41162

See more details on using hashes here.

Provenance

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