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.26b24.tar.gz (475.1 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.26b24-py3-none-any.whl (323.4 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.6.26b24.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.6.26b24.tar.gz
  • Upload date:
  • Size: 475.1 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.26b24.tar.gz
Algorithm Hash digest
SHA256 1d893bb32f233c74441a5939fe5dbd061fad6bec81913f715e2874a1934771ee
MD5 40257fa1a4269e5280704542c1b0a19b
BLAKE2b-256 1718d8d77d4e3cf83aabb8a266475669cf4915d779ecc395eabe8e9a2eec5a25

See more details on using hashes here.

Provenance

The following attestation bundles were made for librefang_sdk-2026.6.26b24.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.26b24-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.6.26b24-py3-none-any.whl
Algorithm Hash digest
SHA256 156ab0aa050b363b09819acc9044280cd72dcfe34e6c46c301a3a2ae89c5fc5d
MD5 2ba8db8829402f1d4f72f8c92e29fd13
BLAKE2b-256 c32752d3b881c9c9b415025e01f907230f674bf20b9a7b61bab0f6b503dcef08

See more details on using hashes here.

Provenance

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