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.25b13.tar.gz (471.4 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.25b13-py3-none-any.whl (320.6 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.5.25b13.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.5.25b13.tar.gz
  • Upload date:
  • Size: 471.4 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.25b13.tar.gz
Algorithm Hash digest
SHA256 c0209b7e1b088ca57f828c4e9371b470dad3ee141b468342bd55f14266195b4d
MD5 15c4828d7335267f03ec952d93be5b4c
BLAKE2b-256 e6dda45d9cd4009dc28b971432e1eae746d31ef4e8331935504447a2a73f8c75

See more details on using hashes here.

Provenance

The following attestation bundles were made for librefang_sdk-2026.5.25b13.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.25b13-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.5.25b13-py3-none-any.whl
Algorithm Hash digest
SHA256 feb311df28a24f5bff6b2a5560594b86300fdddc7389f33f7c4c08632722a952
MD5 8533117747dcc8ea601b895dd202bb41
BLAKE2b-256 e08255f3144234db0aad8ecd0f240e6b5bfe1b2f059b1584db13b03a830c6c68

See more details on using hashes here.

Provenance

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