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.16b19.tar.gz (472.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.6.16b19-py3-none-any.whl (321.0 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.6.16b19.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.6.16b19.tar.gz
  • Upload date:
  • Size: 472.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.6.16b19.tar.gz
Algorithm Hash digest
SHA256 c3ee2a0c39a20944e1453fb1a9854556defb3eba4e7c990e24438458157554f4
MD5 11dbe4a5700881c12425aa129d67e37b
BLAKE2b-256 684b5d2e46f6bc2fa554ae9394e9e27b94400ef592104e6b93a0a5978634b99a

See more details on using hashes here.

Provenance

The following attestation bundles were made for librefang_sdk-2026.6.16b19.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.16b19-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.6.16b19-py3-none-any.whl
Algorithm Hash digest
SHA256 89e97c34314eaccc64b40e4cb926ef8e5c600dfe5110e1657dff669cf4095ab5
MD5 dd10bc9fdf1e264fe89353dceb0c11ff
BLAKE2b-256 830d7c42acf78ada1c2d029154dfa6f13e2ee82835db74a49a26de1ee551f052

See more details on using hashes here.

Provenance

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