Skip to main content

Drop-in replacement for python-docx that connects to Athena's Superdoc/Keryx collaborative document stack

Project description

athena-python-docx

Drop-in replacement for python-docx that connects to Athena's Superdoc + Keryx collaborative document stack.

Quick start

from docx import Document
from docx.shared import Inches, Pt, RGBColor

# Open an existing SuperDoc asset by its Athena asset_id
with Document("asset_abc123") as doc:
    doc.add_heading("Market Analysis", level=1)

    p = doc.add_paragraph()
    r = p.add_run("Revenue grew ")
    highlight = p.add_run("12.3% year-over-year")
    highlight.bold = True
    highlight.font.color.rgb = RGBColor(0x00, 0x80, 0x00)
    p.add_run(".")

    t = doc.add_table(rows=2, cols=2, style="TableGrid")
    t.cell(0, 0).text = "Segment"
    t.cell(0, 1).text = "Revenue"
    t.cell(1, 0).text = "Enterprise"
    t.cell(1, 1).text = "$4.3M"

    doc.save()

API parity rule

This SDK mirrors python-docx's public API exactly. See CLAUDE.md for the full contract.

Development

uv venv
uv pip install -e ".[dev]"
uv run pytest tests/ -x

DocX Execution Lab

For fast local repros against real Athena document assets, use the headless runner in scripts/docx_exec_lab.py. It executes an arbitrary Python snippet with this checkout of athena-python-docx, captures stdout/stderr/errors/timings, and can export the resulting .docx for text assertions. scripts/docx_exec_lab_server.py adds a local UI with an Olympus/SuperDoc embed preview pane. See DOCX_EXEC_LAB.md.

Environment variables

Required when connecting to Keryx (set by Athena backend when executing in Daytona):

  • SUPERDOC_COLLAB_TOKEN — short-lived Keryx JWT
  • KERYX_WS_URL — Keryx WebSocket base URL
  • ATHENA_WORKSPACE_ID — workspace routing segment

License

MIT

Project details


Download files

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

Source Distribution

athena_python_docx-0.18.3.tar.gz (782.6 kB view details)

Uploaded Source

Built Distribution

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

athena_python_docx-0.18.3-py3-none-any.whl (273.1 kB view details)

Uploaded Python 3

File details

Details for the file athena_python_docx-0.18.3.tar.gz.

File metadata

  • Download URL: athena_python_docx-0.18.3.tar.gz
  • Upload date:
  • Size: 782.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for athena_python_docx-0.18.3.tar.gz
Algorithm Hash digest
SHA256 266509528e0d3b0b2c4c23e009bf544d5a374b2423635fc0c9862eab1b7375aa
MD5 cab3d5dc4d8f5d710192ea10b4ab9d88
BLAKE2b-256 b01e10bd7316bc67d688b91b6f8d627c0390a0e89c1d1538ce8925a025dc2110

See more details on using hashes here.

File details

Details for the file athena_python_docx-0.18.3-py3-none-any.whl.

File metadata

File hashes

Hashes for athena_python_docx-0.18.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b32b34b2d678c6e79bd725f19aba9cc443ad4c4ef45888914d8f331b9300755a
MD5 bc64a8695c608deb6f473c01cf85f352
BLAKE2b-256 7fdcfacbf6f46e2e305fe422f689018408a880f8e3279a2b6309285604a67dea

See more details on using hashes here.

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