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.3.25rc6.tar.gz (7.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.3.25rc6-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.3.25rc6.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.3.25rc6.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for librefang_sdk-2026.3.25rc6.tar.gz
Algorithm Hash digest
SHA256 d87a1b598a7506c55ad3a169ecffbf346c28276c5d71e850b88c1293ff6e27a0
MD5 4cd736a8689d4dc8814256706c8b5fdd
BLAKE2b-256 cdee3afdcea8dc1b9fa29fca27260dcea982d726008cfefe44e6bbf945b7e24a

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.3.25rc6-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.3.25rc6-py3-none-any.whl
Algorithm Hash digest
SHA256 9cd5f9dd66286bd75cb1d4b4a31b88345b83da8d64c05355d9f35e760554c89e
MD5 921f8f9a5300710dcb32b5e33851f423
BLAKE2b-256 4a256635d3b3687dd387d77325d6714c829d523eddab645f8c1654a8bad5e61d

See more details on using hashes here.

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