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.4.11b18.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.4.11b18-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for librefang_sdk-2026.4.11b18.tar.gz
Algorithm Hash digest
SHA256 91932b3b03b49108c8e15e4d3013afdbb2801e4bbc1e93be2505bd94065d0623
MD5 62f276148fb931bb98f3e3db5e5e44a7
BLAKE2b-256 f7278dc15e750a514f06cd91cd34038632f7edbcf7aa26047a28193aa968bfb1

See more details on using hashes here.

File details

Details for the file librefang_sdk-2026.4.11b18-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.4.11b18-py3-none-any.whl
Algorithm Hash digest
SHA256 e446b693b858837816f620e8a46a954213cf6d180e19907159d5c827bb1bff60
MD5 6fb63a12358c077a5ee6eea5c74f0dd2
BLAKE2b-256 1dabb72e191271df1fb851591ca85722b91dde7e752d86d84026145db922555b

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