https://github.com/ruarxive/wparc

Wordpress API data and files archival command line tool
https://github.com/ruarxive/wparc

archives backup digital-preservation wordpress

Last synced: 3 months ago
JSON representation

Wordpress API data and files archival command line tool

• Host: GitHub
• URL: https://github.com/ruarxive/wparc
• Owner: ruarxive
• License: apache-2.0
• Created: 2022-03-31T15:32:22.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-10T07:24:14.000Z (7 months ago)
• Last Synced: 2024-10-10T21:21:10.878Z (4 months ago)
• Topics: archives, backup, digital-preservation, wordpress
• Language: Python
• Homepage:
• Size: 27.3 KB
• Stars: 8
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

• awesome-digital-preservation - wparc - Wordpress API data and files archival command line tool (Other digital objects / Specific CMS)

README

        
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::

.. section-numbering::

Main features

=============

* Data extraction

* Download all media files

Installation

============

Any OS

-------------

A universal installation method (that works on Windows, Mac OS X, Linux, …,

and always provides the latest version) is to use pip:

.. code-block:: bash

    # 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.)

Python version

--------------

Python version 3.6 or greater is required.

Usage

=====

Synopsis:

.. code-block:: bash

    $ wparc [command] [flags]

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

Commands

========

Ping command

----------------

Pings /wp-json/ API endpoint of selected domain

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

.. code-block:: bash

    $ wparc ping --domain arctic.gov.ru

Dump command

----------------

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

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

.. code-block:: bash

    $ wparc dump --domain agentura.ru

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

.. code-block:: bash

    $ wparc getfiles --domain dissident.memo.ru