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.12b11.tar.gz (12.3 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.12b11-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.5.12b11.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.5.12b11.tar.gz
  • Upload date:
  • Size: 12.3 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.12b11.tar.gz
Algorithm Hash digest
SHA256 55c63b6fabd02c720cc4e3edaf3059ffbe86e3691e5e0e2efc8a6fad8f26db46
MD5 ba9f8efa70eda31c1b2938e9b596867d
BLAKE2b-256 869280d565d3b531a0c066b062ee77c23045ed6aaa4f13d52391f7a49e5fdea4

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for librefang_sdk-2026.5.12b11-py3-none-any.whl
Algorithm Hash digest
SHA256 64b5c45c9efcde32b1788888d76b0f26d482dc57fd113ea58b98113b6e739292
MD5 d713009f1843ae725fe043fd9e2f9d7e
BLAKE2b-256 fe98fc9dbff28cffa244b9cf52a7026a4efe20cc899b867612799e36c353bf79

See more details on using hashes here.

Provenance

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