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.31b16.tar.gz (471.7 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.31b16-py3-none-any.whl (320.7 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.5.31b16.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.5.31b16.tar.gz
  • Upload date:
  • Size: 471.7 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.31b16.tar.gz
Algorithm Hash digest
SHA256 4e96496473577556e8e8b8c2f04cb9a7234d4de68d4c5291b16468d0ebdf3a2b
MD5 5fdd9c3db9fbe5376c1934c5e3c2d74f
BLAKE2b-256 5cc518a9f82e11fc6402faf5b6025be884b760a49082e9ed5479a68e23b1da61

See more details on using hashes here.

Provenance

The following attestation bundles were made for librefang_sdk-2026.5.31b16.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.31b16-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.5.31b16-py3-none-any.whl
Algorithm Hash digest
SHA256 5388156b157afe849ac7dfee7bc3778bd5fbf5f3fb1821621364bb862a943888
MD5 164b553dd03cb1d49ef6487ae7738416
BLAKE2b-256 5239ea9e9043fcb6190fa3cee827b1f19dd1bd0b6fa0d77ab55229e4da65a64f

See more details on using hashes here.

Provenance

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