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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for esf_convert-0.2.0.tar.gz
Algorithm Hash digest
SHA256 5db873bab56ae3c3e3389730e7353318671eb65bd255d16e64c126a4c24426ba
MD5 8258c01b9fad93850b1a76b678144a44
BLAKE2b-256 1cc42f79af58e73aa43f2e9a17164e14234cb9d916d7c7855d02125102b312fc

See more details on using hashes here.

Provenance

The following attestation bundles were made for esf_convert-0.2.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-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: esf_convert-0.2.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-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 77c00b3b32c073e631bce4677c98021d062e80a84558f7d28e4d84f0db40c5b0
MD5 bde55860e0a443610b0904a2400e4fb9
BLAKE2b-256 c5a07da7a6af725d0226d6730834a74d7c0f2a41b89e8d145f42e40563a9d80e

See more details on using hashes here.

Provenance

The following attestation bundles were made for esf_convert-0.2.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