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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

commcare_export-1.16.0.tar.gz (389.1 kB view details)

Uploaded Sep 8, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

commcare_export-1.16.0-py3-none-any.whl (66.6 kB view details)

Uploaded Sep 8, 2026 Python 3

File details

Details for the file commcare_export-1.16.0.tar.gz.

File metadata

Download URL: commcare_export-1.16.0.tar.gz
Upload date: Sep 8, 2026
Size: 389.1 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for commcare_export-1.16.0.tar.gz
Algorithm	Hash digest
SHA256	`7707dfa70ea10dd659aaa7b5cd4840e12d634c222c86f3962b6bfcca2e904420`
MD5	`925fdd4777ab0085991018eb1616d744`
BLAKE2b-256	`59993971ff27c4d08998a4166c7565778eab56abff0460304bf9164f13936a02`

See more details on using hashes here.

Provenance

The following attestation bundles were made for commcare_export-1.16.0.tar.gz:

Publisher: publish.yml on dimagi/commcare-export

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: commcare_export-1.16.0.tar.gz
- Subject digest: 7707dfa70ea10dd659aaa7b5cd4840e12d634c222c86f3962b6bfcca2e904420
- Sigstore transparency entry: 2760582769
- Sigstore integration time: Sep 8, 2026
Source repository:
- Permalink: dimagi/commcare-export@05eb6b6ab6062ac27c8f7bce0ad4666247397171
- Branch / Tag: refs/tags/1.16.0
- Owner: https://github.com/dimagi
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@05eb6b6ab6062ac27c8f7bce0ad4666247397171
- Trigger Event: push