Skip to main content

Installation

Using pip​

pip install --upgrade pip setuptools
pip install apibackuper
pipx install apibackuper
# or
uv tool install apibackuper

After installation the apibackuper command is available:

apibackuper --help

Optional extras​

Parquet export and accelerated file downloads are optional:

ExtraEnables
recommendedpandas and pyarrow for Parquet export, plus aria2p for file downloads
pip install "apibackuper[recommended]"

You can also install the pieces separately:

pip install pandas pyarrow   # Parquet export
pip install aria2p           # aria2-backed file downloads

Requirements​

  • Python 3.8 or greater
  • Linux, macOS, or Windows

Install from source​

git clone https://github.com/datacoon/apibackuper.git
cd apibackuper
python -m pip install --upgrade pip setuptools wheel
python -m pip install .

For development dependencies:

python -m pip install -e ".[dev]"

Next steps​