Skip to main content

Installation

Datacrafter requires Python 3.9 or newer.

python3 -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install datacrafter
datacrafter version

From source

git clone https://github.com/apicrafter/datacrafter.git
cd datacrafter
pip install -e .

For tests and linters, install the development extras:

pip install -r requirements-dev.txt
pip install -e .

Optional destinations

File JSONL, BSON, and CSV destinations ship with the core package. Some destinations need extra Python packages:

DestinationPackage
file-parquetpip install "datacrafter[parquet]" (pyarrow)
mongodbpymongo
arangodbpython-arango
couchdbpycouchdb
meilisearchmeilisearch

APIBackuper extractors also need the apibackuper CLI (>=1.0.4) on PATH.

datacrafter check reports missing optional packages for the destination you configured.

Requirements

  • Python 3.9 or greater (CI tests 3.9–3.13)
  • A writable project directory for current/, output/, and state.json

Next steps