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.11b18.tar.gz (472.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.6.11b18-py3-none-any.whl (321.0 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.6.11b18.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.6.11b18.tar.gz
  • Upload date:
  • Size: 472.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.6.11b18.tar.gz
Algorithm Hash digest
SHA256 d05252ba611467a11c6af128a3ab78abde5248e6fa1199f6b58237bea5455227
MD5 9ce140c132a0942bd48ed186ed22d65b
BLAKE2b-256 781797aadbb7db0116f2f37e17b9ec9af67c1005a9f02bf0d860b65723ad9521

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for librefang_sdk-2026.6.11b18-py3-none-any.whl
Algorithm Hash digest
SHA256 862b171699f3f0709f04f74948dedb50c87f6fb1281431da3cddfd82a049330d
MD5 e5d04de699dba6a738a8bc19226f717d
BLAKE2b-256 2fd1dbf56e993c28e78ecc8f3c98ef2341b235a6a983afe209251097fb03db4b

See more details on using hashes here.

Provenance

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