wparc: a command-line tool to backup public data from Wordpress websites using Wordpress API

wparc is a command line tool used to backup data from Wordpress based websites. It uses /wp-json/ API provided by default Wordpress installation and extracts all data and media files

Contents

• 1   Main features
• 2   Installation
  • 2.1   Any OS
  • 2.2   Python version
• 3   Usage
• 4   Commands
  • 4.1   Ping command
  • 4.2   Dump command
  • 4.3   Getfiles command

1   Main features

• Data extraction
• Download all media files

2   Installation

2.1   Any OS

A universal installation method (that works on Windows, Mac OS X, Linux, …, and always provides the latest version) is to use pip:

# Make sure we have an up-to-date version of pip and setuptools:
$ pip install --upgrade pip setuptools

$ pip install --upgrade wparc

(If pip installation fails for some reason, you can try easy_install wparc as a fallback.)

2.2   Python version

Python version 3.6 or greater is required.

3   Usage

Synopsis:

$ wparc [command] [flags]

See also python -m wparc and wparc [command] --help for help for each command.

4   Commands

4.1   Ping command

Pings /wp-json/ API endpoint of selected domain

Pings /wp-json/ endpoint "https://arctic.gov.ru" website

$ wparc ping --domain arctic.gov.ru

4.2   Dump command

Dumps all data routes listed in /wp-json/ API endpoint

Dumps all data from "https://agentura.ru" website

$ wparc dump --domain agentura.ru

4.3   Getfiles command

Downloads all media file listed in "wp_v2_media.jsonl" file that should be dumped using command "dump"

Downloads all media from "dissident.memo.ru" website

$ wparc getfiles --domain dissident.memo.ru