Skip to main content

simple_agents_framework

A markdown file in, a callable agent out. One Python file over the Claude Agent SDK.

import simple_agents_framework as saf

agent = saf.create_agent_from_markdown("doc_reader.md", API_KEY)
agent.ask("which markdown files are here?")   # -> str
agent.ask_html("...")                         # same, streamed as HTML in Jupyter

Agent files

Frontmatter configures, body is the system prompt. Every key is optional:

key effect
name agent name (defaults to the filename)
model e.g. claude-sonnet-5
tools comma-separated allowlist, e.g. Read, Grep, Glob
permission_mode defaults to bypassPermissions — headless agents can't answer prompts

Anything else passes through as a ClaudeAgentOptions kwarg: create_agent_from_markdown(path, key, cwd="/repo", max_turns=5).

API

  • ask(prompt) -> str — blocks, works inside Jupyter too.
  • ask_html(prompt) -> str — same run, streamed into the cell: blue sent, green agent, slate thinking, amber tool call, cyan tool result, red error. The agent's text fills in token by token; tool calls and results appear whole.
  • ask_async(prompt, on_event=None) — on_event(kind, title, body, replace) per update. replace=True means "same block, more text": redraw the last thing you drew instead of appending. Build your own renderer on this.

Follow-up asks resume the previous session, so context carries over.

Files

  • simple_agents_framework.py — the whole thing. python simple_agents_framework.py runs its self-check.
  • doc_reader.md — example agent: reads the markdown in a project and answers questions about it.
  • demo.ipynb — end-to-end walkthrough with streamed output.

Gotcha

The SDK spawns whatever claude is first on PATH. Some tools install a wrapper there that never returns headlessly — if ask() hangs, pass cli_path=Path.home() / ".local/bin/claude".

Metadata

Release files for simple-agents-framework 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for simple-agents-framework 0.1.1
File Size Uploaded Provenance Actions
simple_agents_framework-0.1.1.tar.gz 6.8 kB Without provenance Details for simple_agents_framework-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for simple-agents-framework 0.1.1
File Interpreter ABI Platform Actions
simple_agents_framework-0.1.1-py3-none-any.whl Python 3 none any Details for simple_agents_framework-0.1.1-py3-none-any.whl

Total release size: 14.1 kB

Release files / simple_agents_framework-0.1.1.tar.gz

Download URL simple_agents_framework-0.1.1.tar.gz
Size 6.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0108fb97197c33bb498e13e0e578081960d0563e2f30e4c46095618bdba11e6c
BLAKE2b-256 checksum
How to use checksums
c059340635a23556ae1105545daa93fe07d68846db112fef859aadb586cf40e3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release files / simple_agents_framework-0.1.1-py3-none-any.whl

Download URL simple_agents_framework-0.1.1-py3-none-any.whl
Size 7.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b335bf827d517089084caf634832d40073a6367e77ff72a63793848d2249b506
BLAKE2b-256 checksum
How to use checksums
22c29bc07a71e131ef405a8d5fd9305ef5cc1f306996dda98a2c777068d2e9ab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Security for simple-agents-framework 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files No provenance

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