Le-Club-des-Sans-Sujets/pppadump
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

README info

Browse Source
This commit is contained in:
gauthiier 2021-12-10 11:09:37 +01:00
parent 5280ad2f5e
commit d1f1e5a1fc
1 changed files with 11 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -1,20 +1,25 @@
pppadump pppadump
========= =========
Tool to help manage periodic publishing of [etherpads](http://etherpad.org/) to static files, preserving metadata.
Bunch of scripts to extract documents from an [etherpad](http://etherpad.org/) instance and produce templated static files.
Forked from [constant](https://constantvzw.org/site/)'s [active archives](http://activearchives.org/wiki/Main_Page) [etherdump](https://gitlab.constantvzw.org/aa/etherdump) mixed with logic devised for [varia](https://varia.zone)'s [etherpump](https://git.vvvvvvaria.org/varia/etherpump) project
Requirements
Requirements / dependencies
------------- -------------
* python3 * python3 / pip3
* html5lib * html5lib
* requests (settext) * requests
* python-dateutil, jinja2 (index subcommand) * python-dateutil,
* jinja2
Installation Installation
------------- -------------
pip install python-dateutil jinja2 html5lib pip3 install python-dateutil jinja2 html5lib
python setup.py install python setup.py install
Usage Usage
@ -45,7 +50,6 @@ subcommands
* init * init
* pull * pull
* list * list
* listauthors * listauthors
* gettext * gettext
* settext * settext
@ -61,28 +65,6 @@ To get help on a subcommand:
pppadump revisionscount --help pppadump revisionscount --help
Cookbook
========================
Using pppadump to migrate from one etherpad instance to another
------------------------------------------------------------------
mkdir instance1 && cd instance1
pppadump init
pppadump pull --html --meta
(cd ..)
mkdir instance2 && cd instance2
pppadump init
pppadump pushhtml --basepath ../instance1 ../instance1/p/*.meta.json
NB: sethtml/pushhtml seems to only work on the server itself, ie using API url such as localhost:9001.
NB: This command indescriminantly clobbers pads in instance2 with the HTML of the dumped versions from instance1.
This technique can be used to "reset" the database of a pad by recreating pads (without their history or editor info/colors) in a fresh database.
Magicwords Magicwords
================= =================
Following the suggestions of sister project/friendly fork [etherpump](https://git.vvvvvvaria.org/varia/etherpump/), the magic word mechanism has been expanded (from the inital single hard coded \_\_NOPUBLISH__ value) to and generalized to allow a the use of text markers in the source text to control various options, including options for use in preprocessing and translation of markdown using pandoc. Following the suggestions of sister project/friendly fork [etherpump](https://git.vvvvvvaria.org/varia/etherpump/), the magic word mechanism has been expanded (from the inital single hard coded \_\_NOPUBLISH__ value) to and generalized to allow a the use of text markers in the source text to control various options, including options for use in preprocessing and translation of markdown using pandoc.