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.8b10.tar.gz (12.2 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.8b10-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file librefang_sdk-2026.5.8b10.tar.gz.

File metadata

  • Download URL: librefang_sdk-2026.5.8b10.tar.gz
  • Upload date:
  • Size: 12.2 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.8b10.tar.gz
Algorithm Hash digest
SHA256 3b8ffdb1efb756456a9b3f3fda6f489dfa920124422bf1f3ea8fca3551274ad4
MD5 8507644926e8691b977c7987a3a695a8
BLAKE2b-256 35f8330aeca5836658ba67d0ce71687da34a454292078f6277488e53cda19c4a

See more details on using hashes here.

Provenance

The following attestation bundles were made for librefang_sdk-2026.5.8b10.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.8b10-py3-none-any.whl.

File metadata

File hashes

Hashes for librefang_sdk-2026.5.8b10-py3-none-any.whl
Algorithm Hash digest
SHA256 3b7ca5535ce1bb835f306aa26fa1e48afdc0b47a4b664b5bf201e68dd61dd58a
MD5 d73996384bc96b62a778a6a197af8c98
BLAKE2b-256 e59800493ea2e1a94aac498c1f6984342d58d11131de26751397d28968b087e1

See more details on using hashes here.

Provenance

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