Skip to content

Latest commit

 

History

History

README.md

Maxun Python SDK — Examples

Python equivalents of every Node SDK example.

Setup

1. Install the SDK (from the python-sdk/ directory):

pip install -e .
# With LLM support:
pip install -e ".[all]"

2. Set environment variables (copy .env.example to .env and fill in your values):

cp ../.env.example ../.env
Variable Description Default
MAXUN_API_KEY Your Maxun API key (required)
MAXUN_BASE_URL Base URL of your Maxun server https://app.maxun.dev/api/sdk/
MAXUN_TEAM_ID Team UUID for team-scoped robots (optional)

3. Run any example:

python examples/basic_extraction.py
python examples/simple_scrape.py
python examples/basic_crawl.py
# ... etc.

Examples

File Description Node SDK equivalent
basic_extraction.py Extract specific fields with CSS selectors basic-extraction.ts
simple_scrape.py Scrape a page as Markdown, HTML, or screenshot simple-scrape.ts
basic_crawl.py Crawl multiple pages from a starting URL basic-crawl.ts
basic_search.py Search the web and collect results basic-search.ts
chained_extract.py Multi-step: capture_text + capture_list on one page chained-extract.ts
list_pagination.py Extract lists with scroll / click pagination list-pagination.ts
llm_extraction.py Use a natural-language prompt to build a robot llm-extraction.ts
scheduling.py Schedule robots for periodic execution scheduling.ts
webhooks.py Receive webhook notifications on run events webhooks.ts
robot_management.py List, update, inspect runs, and delete robots robot-management.ts
complete_workflow.py Full workflow: extract + webhook + schedule complete-workflow.ts
form_fill_screenshot.py Fill form inputs and capture screenshots form-fill-screenshot.ts
team_robot.py Create and run a robot scoped to a team team-robot.ts