CommCare Data Export Tool

https://github.com/dimagi/commcare-export

A command-line tool (and Python library) to generate customized exports from the CommCare HQ REST API.

Quick Start

Installation

uv pip install commcare-export

Basic Usage

# Export forms to Markdown (useful for testing)
commcare-export \
    --query examples/demo-registration.xlsx \
    --project YOUR_PROJECT \
    --output-format markdown

# Export to a SQL database with incremental updates
commcare-export \
    --query examples/demo-registration.xlsx \
    --project YOUR_PROJECT \
    --output-format sql \
    --output postgresql://user:pass@localhost/dbname

# Export to Delta Lake tables in cloud storage with incremental updates
commcare-export \
    --query examples/demo-registrations.xlsx \
    --project YOUR_PROJECT \
    --output-format delta \
    --output az://container/commcare \
    --checkpoint-database-url sqlite:///checkpoints.db

Example query files are provided in the examples/ directory for both Excel and JSON formats.

Documentation

For Users

See the User Documentation for installation, creating queries, command-line usage, scheduling, and common use cases.

For Developers

See the Technical Documentation for:

Python Library Usage - Using commcare-export as a Python library
MiniLinq Reference - Query language documentation
Query Formats - Excel and JSON query specifications
Output Formats - Available output formats and dependencies
User and Location Data - Exporting organization data
Command-line Usage - CLI reference
Scheduling - Running DET on a schedule

Contributing

We welcome contributions! See CONTRIBUTING.md for how to set up your development environment, coding style guidelines, testing, and the release process.

Python Versions

Tested with Python 3.10, 3.11, 3.12, and 3.13.

License

MIT License - see LICENSE for details.

Release files for commcare-export 1.16.0

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

Source distribution (sdist)

Source distribution for commcare-export 1.16.0
File	Size	Uploaded
commcare_export-1.16.0.tar.gz	389.1 kB	Sep 8, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for commcare-export 1.16.0
File	Interpreter	ABI	Platform	Reset
commcare_export-1.16.0-py3-none-any.whl 66.6 kB Sep 8, 2026	Python 3	none	any	Details

Total release size: 455.7 kB

Release files / commcare_export-1.16.0.tar.gz

Download URL	commcare_export-1.16.0.tar.gz
Size	389.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`7707dfa70ea10dd659aaa7b5cd4840e12d634c222c86f3962b6bfcca2e904420`
BLAKE2b-256 checksum How to use checksums	`59993971ff27c4d08998a4166c7565778eab56abff0460304bf9164f13936a02`
Upload date	Sep 8, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

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.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/dimagi/commcare-export
Publishing commit: github.com/dimagi/commcare-export/tree/05eb6b6ab6062ac27c8f7bce0ad4666247397171

Workflow

Publishing configuration: github.com/dimagi/commcare-export/blob/05eb6b6ab6062ac27c8f7bce0ad4666247397171/.github/workflows/publish.yml
Publishing logs: github.com/dimagi/commcare-export/actions/runs/34254656810/attempts/1

Artifact

Subject: commcare_export-1.16.0.tar.gz
SHA-256 checksum: 7707dfa70ea10dd659aaa7b5cd4840e12d634c222c86f3962b6bfcca2e904420 Verifying attestations

Release files / commcare_export-1.16.0-py3-none-any.whl

Download URL	commcare_export-1.16.0-py3-none-any.whl
Size	66.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`051a0d1a1b73d365d46462d4059c0a6ee17a463917004dcda30de96cb924fc62`
BLAKE2b-256 checksum How to use checksums	`bfab10c6a5eac117996bb300b604fbffb636943b3551385121e0ad5062aae606`
Upload date	Sep 8, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/dimagi/commcare-export
Publishing commit: github.com/dimagi/commcare-export/tree/05eb6b6ab6062ac27c8f7bce0ad4666247397171

Workflow

Publishing configuration: github.com/dimagi/commcare-export/blob/05eb6b6ab6062ac27c8f7bce0ad4666247397171/.github/workflows/publish.yml
Publishing logs: github.com/dimagi/commcare-export/actions/runs/34254656810/attempts/1

Artifact

Subject: commcare_export-1.16.0-py3-none-any.whl
SHA-256 checksum: 051a0d1a1b73d365d46462d4059c0a6ee17a463917004dcda30de96cb924fc62 Verifying attestations