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.10b17.tar.gz (471.7 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.10b17-py3-none-any.whl (320.7 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.6.10b17.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.6.10b17.tar.gz
  • Upload date:
  • Size: 471.7 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.10b17.tar.gz
Algorithm Hash digest
SHA256 3058b3c88ea753fc14662e661ca8eded6647ac44397fd0daf2b8149d4ee19d0d
MD5 0502cba3044beb40bfdd6100e0bd5bf7
BLAKE2b-256 da708e4c0879e704893869e8c6786c4f3878f45752e4c38643085120753eca0c

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for librefang_sdk-2026.6.10b17-py3-none-any.whl
Algorithm Hash digest
SHA256 b496557f932ca5c719b7a6e5d7939d11f14decbbcde131670b4abef05b5ee1f0
MD5 6b2c33cef1f59f2e8ef0c9b0e0bba998
BLAKE2b-256 19ef1e31d3000a8d9797e966d3b10d6e1fbea17858f6ca1e4fb972462996f84e

See more details on using hashes here.

Provenance

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