Skip to main content

scitex-msword

SciTeX

MS Word (.docx) reader/writer with journal-style profiles.

Full Documentation · uv pip install scitex-msword[all]

PyPI Python Tests Coverage Docs License: AGPL v3


Installation

pip install scitex-msword

Quick Start

import scitex_msword as sxm

# Word -> intermediate JSON-like document
doc = sxm.load_docx("input.docx", profile="generic")

# JSON-like document -> Word (apply a journal style)
sxm.save_docx(doc, "output.docx", profile="mdpi-ijerph")

# DOCX -> LaTeX (requires the umbrella `scitex` package for the .tex export step)
sxm.convert_docx_to_tex(
    "manuscript.docx", "manuscript.tex",
    profile="resna-2025", image_dir="figures",
)

1 Interfaces

Python API
import scitex_msword as sxm

# Round-trip
doc = sxm.load_docx("paper.docx", profile="generic")
sxm.save_docx(doc, "paper-styled.docx", profile="ieee")

# Helpers
sxm.link_captions_to_images(doc)
sxm.link_captions_to_images_by_proximity(doc)
sxm.normalize_section_headings(doc)
sxm.validate_document(doc)
sxm.create_post_import_hook(doc)

# Register custom profile
sxm.register_profile("my-style", {...})

Review / dogfooding helpers (unreleased)

import docx
import scitex_msword as sxm

# 1. Diff two .docx versions by paragraph (paragraphs in/out + run-level
#    bold / italic / font / highlight deltas).
ops = sxm.diff_docx("v15.docx", "v16.docx")
sxm.summarize_diff(ops)            # {'equal': 38, 'insert': 4, 'delete': 1, 'modify': 3}

# 2. Visualize edits with highlights (BOOST review convention).
doc = docx.Document("v16.docx")
sxm.mark_additions(doc, runs=[(3, 0), (5, 2)])     # default turquoise
sxm.mark_modifications(doc, runs=[(7, 1)])         # default magenta -> Word PINK

# 3. Read highlights back, bucketed by color name.
sxm.extract_highlights(doc)        # {'turquoise': [...], 'pink': [...]}

# 4. Bold-preserve keyword tokens (Japanese tokens get MS Gothic).
sxm.preserve_bold_tokens(doc, tokens=["JST", "BOOST", "Sovereign Tech"])

# 5. Pull Word comments + their anchor ranges.
comments = sxm.extract_comments("v16.docx")
# Optionally apply REPLACE:-grammar comments as edits.
summary = sxm.apply_comments_as_edits(doc)         # {'applied': 2, 'skipped': 4, ...}

Track Changes (revision) helpers

import docx
import scitex_msword as sxm

# 1. Turn Word's "Track Changes" switch on, so subsequent operator edits
#    are recorded as revisions (writes <w:trackChanges/> to settings.xml).
doc = docx.Document("draft.docx")
sxm.enable_track_changes(doc, enabled=True)
sxm.is_track_changes_enabled(doc)        # True

# 2. Wrap agent edits as <w:ins> / <w:del> so Word renders them as
#    accept/reject-able revisions.
p = doc.paragraphs[10]
sxm.wrap_as_tracked_insertion(p, runs=[2, 3], author="agent")
sxm.wrap_as_tracked_deletion(p, runs=[5],    author="agent")

# 3. Inspect all tracked changes (structured).
for c in sxm.extract_tracked_changes(doc):
    print(c["type"], c["author"], c["text"])

# 4. Bulk accept / reject (Word's "Accept All" / "Reject All").
sxm.accept_all_tracked_changes(doc)        # or reject_all_tracked_changes
doc.save("draft_v27.docx")

MCP server (optional)

pip install scitex-msword[mcp]
python -m scitex_msword.mcp_server          # stdio transport

Tools exposed: diff_docx_tool, mark_additions_tool, mark_modifications_tool, preserve_bold_tokens_tool, extract_highlights_tool, extract_comments_tool, list_profiles_tool.

Built-in profiles

generic, mdpi-ijerph, resna-2025, iop-double-anonymous, ieee, springer, elsevier, boost-2026.

Status

Standalone fork of scitex.msword. Only runtime dep is python-docx. The umbrella scitex.msword import path is preserved via a sys.modules-alias bridge. convert_docx_to_tex lazily imports scitex.tex, so it works only when the umbrella package is also installed.

Architecture

scitex_msword/
├── _load.py              ← `load_docx` — DOCX → JSON-like document
├── _save.py              ← `save_docx` — apply profile, write DOCX
├── _convert.py           ← `convert_docx_to_tex` (lazy scitex.tex import)
├── profiles/             ← built-in journal styles
│   ├── generic.py        ← default
│   ├── ieee.py
│   ├── mdpi_ijerph.py
│   ├── resna_2025.py
│   ├── springer.py
│   └── elsevier.py
├── helpers/              ← caption-image linking, heading normalization
└── _registry.py          ← `register_profile` for user styles

Demo

flowchart LR
    A[draft.docx] -->|load_docx| B[JSON-like doc]
    B -->|save_docx<br/>profile=ieee| C[submission.docx]
    B -->|convert_docx_to_tex| D[manuscript.tex]
import scitex_msword as sxm

doc = sxm.load_docx("draft.docx", profile="generic")
sxm.save_docx(doc, "submission.docx", profile="ieee")

Round-trips DOCX through a JSON-like intermediate, then re-renders with IEEE column widths, fonts, and heading numbering applied automatically.

Part of SciTeX

scitex-msword is part of SciTeX. Install via the umbrella with pip install scitex[msword] to use as scitex.msword (Python) or scitex msword ... (CLI).

Four Freedoms for Research

  1. The freedom to run your research anywhere — your machine, your terms.
  2. The freedom to study how every step works — from raw data to final manuscript.
  3. The freedom to redistribute your workflows, not just your papers.
  4. The freedom to modify any module and share improvements with the community.

AGPL-3.0 — because we believe research infrastructure deserves the same freedoms as the software it runs on.

License

AGPL-3.0-only (see LICENSE).


SciTeX

Metadata

Release files for scitex-msword 0.3.2

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

Source distribution (sdist)

Source distribution for scitex-msword 0.3.2
File Size Uploaded Provenance
scitex_msword-0.3.2.tar.gz 84.9 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for scitex-msword 0.3.2
File Interpreter ABI Platform
scitex_msword-0.3.2-py3-none-any.whl Python 3 none any Details

Total release size: 185.9 kB

Release files / scitex_msword-0.3.2.tar.gz

Download URL scitex_msword-0.3.2.tar.gz
Size 84.9 kB
Tags Source
SHA-256 checksum
How to use checksums
826dbb4d0d2160ca0b3a2272b85c044806a94e22c5bed2fa457152c7d6d71141
BLAKE2b-256 checksum
How to use checksums
a612a444aeb4bdd62fc6399bcffee041110237215d957c571c98ae983b7f8325
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 4, 2026.

Transparency log

Release files / scitex_msword-0.3.2-py3-none-any.whl

Download URL scitex_msword-0.3.2-py3-none-any.whl
Size 101.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e89604da11c915655d3f313794f06831da5707f28efb7def83e26e0976000c43
BLAKE2b-256 checksum
How to use checksums
76b787b15ebbe5e330497e10c7813d4b1396b928a712e99b0d3dbfcc77608496
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 4, 2026.

Transparency log

Security for scitex-msword 0.3.2

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.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for scitex_msword-0.3.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 4, 2026.

Transparency log

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.

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