Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Friday Agent Framework

Friday is a Python framework for building AI agents that can remember, retrieve, act, and collaborate across sessions. The project is organized as a uv workspace of independently useful packages covering memory, LLM access, agent orchestration, tools, transcripts, telemetry, sandboxing, MCP integration, and runtime assembly.

The core idea is simple: an agent should not start from zero every time it is called. Friday gives agents a memory loop that records what happened, extracts what was learned, retrieves relevant context, and feeds that context back into future turns.

Status: v0.1.0, alpha. The memory, agent, runtime, and tool packages contain substantial implementation, but the repository is still under active architectural cleanup. Some documentation describes the target system as well as the current system.

What Friday Provides

  • Three-tier memory:
    • Episodic memory for conversation history and transcripts.
    • Semantic memory for embedding-backed recall.
    • Associative memory for entity and relationship graphs.
  • Context engineering:
    • Retrieval from memory stores.
    • Token-budget-aware prompt assembly.
    • Session priming and lifecycle-aware memory inclusion.
  • Agent orchestration:
    • Interactive ReAct-style agents.
    • Multi-agent routing and delegation.
    • Workflow/task graph execution with human-in-the-loop support.
  • Tooling:
    • Filesystem, shell, web, git, data, text, code, system, finance, and memory tools.
    • Tool schemas for LLM function/tool calling.
    • Prompt-injection-aware output handling.
  • Runtime infrastructure:
    • Headless runtime kernel.
    • Dependency injection for memory, LLM, telemetry, transcripts, and tools.
    • CLI-facing presentation components.
  • Observability:
    • Structured logging.
    • Telemetry interfaces and providers.
    • Persistent transcripts and export formats.
  • Extensibility:
    • Protocol-oriented interfaces for memory stores, LLM clients, tools, transcripts, telemetry, and runtime services.
    • MCP client/server integration.
    • Optional local/cloud/hybrid model routing through LiteLLM-compatible services.

Repository Layout

.
├── docs/
│   ├── guides/                 # Product and usage documentation
│   ├── policies/               # Repository engineering policy
│   └── design/                 # Design notes and implementation plans
├── experiments/                # Labs and exploratory work
├── packages/                   # Python workspace packages
├── tests/                      # Top-level integration/lab/unit suites
├── main.py                     # Minimal smoke entry point
├── pyproject.toml              # Root workspace project
└── uv.lock                     # Locked dependency graph

The root project is a convenience workspace package named friday. Most code lives under packages/.

Package Map

Package Purpose Notes
friday-core Shared interfaces, config, logging, security primitives, exceptions Intended foundation layer. Some current factory/bridge code still reaches into concrete packages.
friday-telemetry Telemetry records, interfaces, providers, helper models Includes debug and OpenTelemetry-style provider support.
friday-llm LiteLLM-backed chat and embedding services Includes resilience, pricing, telemetry helpers, and provider config.
friday-transcript Persistent transcript models, stores, and exporters SQLite and JSONL-oriented transcript storage/export support.
friday-memory Memory controller, adapters, lifecycle, retrieval, context assembly, ingestion, multi-agent memory The largest and most central package.
friday-agent Agent base classes, interactive/Copilot agents, registries, orchestration, workflows, built-in agent tools CopilotAgent currently aliases the interactive runtime agent for compatibility.
friday-runtime Headless runtime kernel and dependency injection Preferred assembly layer for creating full framework services.
friday-cli Terminal display/input/session components and server hooks The declared friday console entry point is still under development in this checkout.
friday-tools General and integration tool catalog Includes filesystem, shell, web, git, data, document, code, memory, finance, and integration tools.
friday-sandbox Workspace and subprocess/Docker sandbox support Used by execution-related tools and runtime isolation work.
friday-mcp Model Context Protocol client/server integration Supports stdio/SSE-oriented MCP components.
friday-speech Speech service interfaces, selection, chunking, playback, adapters Optional Picovoice and ElevenLabs extras are defined.
friday-finance Financial data provider integration Includes a friday-finance-demo script.
friday-moltbook Moltbook API client and Pydantic models Used by Moltbook integration tools.
friday-optimization DSPy/lab optimization package Currently a playground package rather than a core runtime dependency.

Architecture Overview

Friday separates agent work into two broad areas:

User input
   |
   v
RuntimeKernel / DI container
   |
   +--> LLM service
   +--> Tool registry
   +--> Transcript store
   +--> MemoryController
          |
          +--> Episodic store      conversation turns
          +--> Vector store        semantic memories
          +--> Graph store         entities and relationships
          +--> Collection manager  lifecycle-aware memory collections
   |
   v
Agent / Orchestrator / Workflow engine
   |
   +--> Context assembly
   +--> LLM inference
   +--> Tool execution
   +--> Transcript and memory archival

The memory loop is the central design:

  1. A user asks a question or gives a task.
  2. Friday retrieves relevant prior context from memory.
  3. The agent sends an assembled prompt to an LLM.
  4. The LLM responds directly or requests tool calls.
  5. Tool results are sanitized, wrapped, and returned to the model.
  6. The turn is archived to transcript/episodic memory.
  7. Extracted insights, entities, and relationships are stored for future turns.
  8. Lifecycle jobs can promote, decay, compact, or reorganize memories over time.

Installation

Friday uses uv for workspace development.

uv sync --all-extras

For a lighter development install, the default sync is usually enough:

uv sync

Then verify imports:

uv run python -c "from friday_runtime import RuntimeKernel; from friday_agent import InteractiveAgent; print('Friday imports OK')"

Configuration

Start from the example environment file:

cp .env.example .env

Minimum useful environment:

APP_ENV=development
LOG_LEVEL=INFO
OPENAI_API_KEY=sk-proj-...

Common runtime variables include:

FRIDAY_LLM_MODEL=gpt-4o-mini
FRIDAY_CHROMA_PATH=.friday/chroma
FRIDAY_CHROMA_COLLECTION=friday_memory
FRIDAY_TELEMETRY_ENABLED=false

Local or enterprise model gateways can be configured through the runtime and LLM configuration objects. See docs/guides/10-configuration.md for the full configuration guide.

Programmatic Usage

The headless runtime is the main composition API for applications that want to embed Friday without a CLI.

import asyncio

from friday_core.profiles import MemoryProfile
from friday_runtime import RuntimeConfig, RuntimeKernel


async def main() -> None:
    config = RuntimeConfig.from_env()
    kernel = RuntimeKernel(config=config, memory_profile=MemoryProfile.FULL)

    await kernel.start()
    try:
        # Agent spawning requires configured agent profiles.
        # See docs/guides/06-agents.md for profile structure.
        agent = kernel.spawn_agent("assistant")
        response = await agent.run("What do you remember about this project?")
        print(response)
    finally:
        await kernel.stop()


if __name__ == "__main__":
    asyncio.run(main())

For lower-level use, individual packages can be imported directly:

from friday_llm import LiteLLMService
from friday_memory import ContextAssembler, MemoryController
from friday_agent import AgentProfile, InteractiveAgent
from friday_tools import get_default_registry

Development Commands

Install dependencies:

uv sync --all-extras

Run tests:

uv run pytest

Run a focused package test suite:

uv run pytest packages/friday-memory/tests_memory
uv run pytest packages/friday-agent/tests_agent
uv run pytest packages/friday-runtime/tests_runtime

Run linting:

uv run ruff check .

Run type checking:

uv run mypy packages tests main.py

Run the minimal smoke entry point:

uv run python main.py

Testing Notes

The repository uses:

  • pytest
  • pytest-asyncio
  • ruff
  • mypy

Tests are distributed by package, usually under packages/<package>/tests_*. Top-level integration and lab tests live under tests/ and experiments/.

Some tests and integrations require provider credentials, local model services, network access, Docker, or pre-existing local state. Prefer focused package tests while developing a narrow change.

Security Model

Friday treats tool outputs and external content as untrusted. The security subsystem is designed around:

  • Normalizing tool output before scanning.
  • Detecting prompt-injection patterns.
  • Wrapping tool output with provenance markers.
  • Quarantining, redacting, warning, or blocking risky content.
  • Avoiding persistence of raw malicious tool output into memory stores.

See docs/guides/security-configuration-guidelines.md for configuration details and the tool onboarding checklist.

Documentation

Primary product guides:

Repository policy:

Important note: the guides are extensive and useful, but some package-layout and CLI details are ahead of or behind the current code. When making code changes, prefer the repository policy and current package metadata as the source of truth.

Engineering Policy

The canonical engineering policy is docs/reference/policies/repository-engineering-policy.md. Key rules:

  • Do not add file-level # mypy: ignore-errors under packages/*/src without an explicit waiver.
  • Do not rely on assert as the sole enforcement for essential runtime invariants.
  • Prefer typed models, declared interfaces, and explicit contracts at package boundaries.
  • Prefer interface fixes over repeated cast(...).
  • Keep runtime credentials and local state out of the repository.

Local State and Secrets

Do not commit:

  • .env
  • .friday/
  • chroma_db/
  • provider API keys
  • local transcript/vector/graph stores
  • generated caches such as __pycache__, .pytest_cache, and .ruff_cache

Current Development Caveats

This repository is actively evolving. A few areas are especially worth knowing before building on it:

  • The package architecture has grown beyond older documentation that describes an eight-package workspace.
  • The root main.py is only a minimal smoke script.
  • The friday-cli package contains useful terminal components, but the declared console application entry point is not yet a complete CLI in this checkout.
  • friday-optimization is currently lab-oriented.
  • Some integration and backup code under tests/ is legacy or experimental and may not represent stable public API usage.

Contributing

Before changing code:

  1. Read docs/reference/policies/repository-engineering-policy.md.
  2. Identify the package boundary affected by the change.
  3. Prefer narrow, typed contracts over incidental cross-package imports.
  4. Add focused regression tests for behavior changes.
  5. Run the narrowest meaningful tests, then broader validation when practical.

Pull requests should include:

  • What changed.
  • Why it changed.
  • How to validate it.
  • Package or configuration implications.
  • Any migration notes for public contracts or persisted data.

License

The root project metadata declares the project as MIT licensed.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

friday_framework-0.1.0a2.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

friday_framework-0.1.0a2-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file friday_framework-0.1.0a2.tar.gz.

File metadata

  • Download URL: friday_framework-0.1.0a2.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.10

File hashes

Hashes for friday_framework-0.1.0a2.tar.gz
Algorithm Hash digest
SHA256 4eb960897900e142162ae640a67eec28e6fad36d1f2994613cf2b9a9101404b5
MD5 67b0e5bd1f6abe0e765c0568d6eedc59
BLAKE2b-256 8ae59bfe06a900245e3081a97b7f2ed0aa79adafdbbce7260b6f5518fab88878

See more details on using hashes here.

File details

Details for the file friday_framework-0.1.0a2-py3-none-any.whl.

File metadata

File hashes

Hashes for friday_framework-0.1.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 79e8b187135d5477263a3ebcb6a330c8cf3a28c848b0fc6adbbe2ce5f6bda2a0
MD5 0e71e01af236c8e821f8b00ab133b8ce
BLAKE2b-256 a96515e79af0e6deb90e7e224473b7e1049f920a2af755eae10f5a7d8d488456

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.0a2 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page