Skip to main content

Convert ECHO Single Form (ESF) XML files to Markdown or Word documents

Project description

esf-convert

Convert ECHO Single Form (ESF) XML files to Markdown or Word documents.

Installation

uv tool install esf-convert

Usage

# Convert to Word document (default)
esf-convert form.xml

# Convert to Markdown
esf-convert form.xml -f md

# Specify output file (format auto-detected from extension)
esf-convert form.xml -o report.md

# Explicit format with custom output name
esf-convert form.xml -f md -o my-report

Options

Option Description
-o, --output Output file path (default: input filename with .docx extension)
-f, --format Output format: docx (Word, default) or md (Markdown). Auto-detected from output extension if not specified.

Features

  • Structured output - Chapters, sections, and subsections with proper heading hierarchy
  • Field tips - Form guidelines/tips displayed in italics below each field heading
  • Enum labels - Numeric values (0, 1, 2) converted to human-readable labels (No, Yes, Partially, etc.)
  • Outcome indicators - Section 7.2 indicators with definition, baseline, target, and progress values
  • Results - Section 7.3 results with indicators and activities
  • Metadata - Reference numbers, dates, document type (YAML frontmatter in Markdown, table in DOCX)

Development

Requires Python 3.10+.

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

esf_convert-1.0.0.tar.gz (480.8 kB view details)

Uploaded Source

Built Distribution

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

esf_convert-1.0.0-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file esf_convert-1.0.0.tar.gz.

File metadata

  • Download URL: esf_convert-1.0.0.tar.gz
  • Upload date:
  • Size: 480.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for esf_convert-1.0.0.tar.gz
Algorithm Hash digest
SHA256 489726d09d4d272ccbbf5eb25b9c52748e07c476ad6d733333890423eda1c031
MD5 d62c2688f7eab74334470345416ff83a
BLAKE2b-256 44f7b9d5689836b509092229efb917a0318026538b6ee16c1b9f3e9c59982912

See more details on using hashes here.

File details

Details for the file esf_convert-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: esf_convert-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for esf_convert-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 af22775e36c227d4605e2bce1491242ba15e71029fc4b56b485d66090d52d18c
MD5 3d7bf7b0591a57ed9536e2181c697882
BLAKE2b-256 01ea7c68e6e05f196ec1fa267b63355b3c56619a8e542451fa0bbe8e0063a55a

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