Skip to main content

MS Word (.docx) reader/writer with journal-style profiles (MDPI, IEEE, Springer, Elsevier, RESNA, IOP) — standalone module from the SciTeX ecosystem

Project description

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", {...})

Built-in profiles

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

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

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

scitex_msword-0.1.3.tar.gz (35.1 kB view details)

Uploaded Source

Built Distribution

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

scitex_msword-0.1.3-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

Details for the file scitex_msword-0.1.3.tar.gz.

File metadata

  • Download URL: scitex_msword-0.1.3.tar.gz
  • Upload date:
  • Size: 35.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scitex_msword-0.1.3.tar.gz
Algorithm Hash digest
SHA256 e6fe2e6b7d81f788946a8aab0a48a4c9ca66b7c8e288466522e0133566368b39
MD5 2ec2973a624a58b377a3b56380fbe217
BLAKE2b-256 a671c4d314baf3e67b0d48bd017749319ebdba0ec72c8cf0d07361992e07fc09

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_msword-0.1.3.tar.gz:

Publisher: publish-pypi.yml on ywatanabe1989/scitex-msword

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scitex_msword-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: scitex_msword-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 36.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for scitex_msword-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d921f05b836a59542093f77ce26abb32230637755705fc30c97bf48324a4e1ea
MD5 c2a1283d78847dc10d3b92020b234c6f
BLAKE2b-256 469f83a550ba1504f1c84d7fbc105e045e11d0da6d2e564e54993026d4c0386e

See more details on using hashes here.

Provenance

The following attestation bundles were made for scitex_msword-0.1.3-py3-none-any.whl:

Publisher: publish-pypi.yml on ywatanabe1989/scitex-msword

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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