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.

Web Interface

Use the converter directly in your browser - no installation required:

Launch Web App

The web app runs entirely client-side using WebAssembly. Your files are never uploaded to any server.

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.1.0.tar.gz (25.7 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.1.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: esf_convert-1.1.0.tar.gz
  • Upload date:
  • Size: 25.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for esf_convert-1.1.0.tar.gz
Algorithm Hash digest
SHA256 f690ddf08cc73f0d978ac85735eff4012eacb7c82e46b08bf2ae0aeb7434611e
MD5 6ce86c30135017b8389bd04c73a95320
BLAKE2b-256 aff70130c3dfd365a9fc5ed6aa2a140815175f1ce81862e2c793293a32a98b56

See more details on using hashes here.

Provenance

The following attestation bundles were made for esf_convert-1.1.0.tar.gz:

Publisher: publish.yml on brianmcdonald/ESF-convert

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

File details

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

File metadata

  • Download URL: esf_convert-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for esf_convert-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3dd61de7f27d845fdf549da17600553d748fc4dce810a4227968503fd141852a
MD5 75f8b3402b26a26e11913b5a5594f2b2
BLAKE2b-256 76f6addafd93cc6e3738c5829d3efdc117a0a2f873a69a0d1d8a8e30d88bfac0

See more details on using hashes here.

Provenance

The following attestation bundles were made for esf_convert-1.1.0-py3-none-any.whl:

Publisher: publish.yml on brianmcdonald/ESF-convert

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