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.30b15.tar.gz (471.6 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.30b15-py3-none-any.whl (320.7 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.5.30b15.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.5.30b15.tar.gz
  • Upload date:
  • Size: 471.6 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.30b15.tar.gz
Algorithm Hash digest
SHA256 0afb3e6ff1d6c2e60459fbbeb2b499a519ee0ac9d7734a4fb80dd44263f154ee
MD5 cd0852a71aa2ca4a5ae86565214f5cf4
BLAKE2b-256 f91dc2f72c3b5d809036ca480fd630c8673e7bd3f3f9abb20b68755977326f26

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for librefang_sdk-2026.5.30b15-py3-none-any.whl
Algorithm Hash digest
SHA256 4f6654fbfa125b6896d6292b12721bbc7fb2b03ef6b21449aba07335f9768df2
MD5 ee4a3ec49e14f02dd4cac3ec21e8432e
BLAKE2b-256 f6824a24447ae519017e7cace9881cc83dc66a2ef4e640566fa2e925474b2fa9

See more details on using hashes here.

Provenance

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