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.22b21.tar.gz (474.9 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.22b21-py3-none-any.whl (323.4 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.6.22b21.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.6.22b21.tar.gz
  • Upload date:
  • Size: 474.9 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.22b21.tar.gz
Algorithm Hash digest
SHA256 eb87f7eaede975854d258cd501b6319f0fabdb1cca9c0021288ac49cfbdcc970
MD5 00901441db36832dae95780b1a02f6ad
BLAKE2b-256 666491b5341872d830267d823e9882b00383ba4248afa852184de824b9406949

See more details on using hashes here.

Provenance

The following attestation bundles were made for librefang_sdk-2026.6.22b21.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.22b21-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.6.22b21-py3-none-any.whl
Algorithm Hash digest
SHA256 d072d321925c07a80a865724c32a0d49a965c9e0aa573607e35b6e85c8d61d29
MD5 dc584a604d19d2c1feae4160ad104a59
BLAKE2b-256 6ff22a4a2f29cc5e5152cd0a124051f099a90b8ddac84e858ffefff8a258bc6c

See more details on using hashes here.

Provenance

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