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.17b20.tar.gz (474.5 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.17b20-py3-none-any.whl (322.7 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.6.17b20.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.6.17b20.tar.gz
  • Upload date:
  • Size: 474.5 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.17b20.tar.gz
Algorithm Hash digest
SHA256 e99addb0eb0c1bb33007d8c0b3f58fcc5174f93060f33e783d4a8968a07bf2a2
MD5 6423e7968526bac9729ff13cb213238f
BLAKE2b-256 5dae0bccd34447bc8620f0315328f4b12fd498f3ff6bd88fc6366f08837fef4e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for librefang_sdk-2026.6.17b20-py3-none-any.whl
Algorithm Hash digest
SHA256 11cfc746e62cb2bd9745ffb8403a5d3ac9558a1a03b7da38892c262e85b877eb
MD5 0036d5f33f7ddf926e4234c4263482c7
BLAKE2b-256 85cfc35cf82f2f9e9982e50db8ed05aad8433057d05274baf1eec8b7a8b39481

See more details on using hashes here.

Provenance

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