69 lines
1.4 KiB
Markdown
69 lines
1.4 KiB
Markdown
etherdump
|
|
=========
|
|
|
|
Tool to publish [etherpad](http://etherpad.org/) pages to files.
|
|
|
|
|
|
Requirements
|
|
-------------
|
|
|
|
python-dateutil, html5lib
|
|
|
|
|
|
Installation
|
|
-------------
|
|
|
|
pip install python-dateutil html5lib
|
|
python setup.py install
|
|
|
|
Example
|
|
---------------
|
|
mkdir mydump
|
|
cd myddump
|
|
etherdump init
|
|
|
|
The program then interactively asks some questions:
|
|
|
|
Please type the URL of the etherpad:
|
|
http://automatist.local:9001/
|
|
The APIKEY is the contents of the file APIKEY.txt in the etherpad folder
|
|
Please paste the APIKEY:
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
|
|
The settings are placed in a file called .etherdump/settings.json and are used (by default) by future commands.
|
|
|
|
|
|
|
|
subcommands
|
|
----------
|
|
|
|
* init
|
|
* pull
|
|
* list
|
|
* listauthors
|
|
* gettext
|
|
* gethtml
|
|
* creatediffhtml
|
|
* revisionscount
|
|
|
|
To get help on a subcommand:
|
|
|
|
etherdump revisionscount --help
|
|
|
|
file sync
|
|
----------
|
|
epfs?
|
|
pad to file
|
|
|
|
etherdump init http://localhost:9001/ --path foo
|
|
etherdump status
|
|
compare state of files to etherpad & report
|
|
etherdump pull <padid/path>
|
|
etherdump sync
|
|
push / pull file contents to pad
|
|
|
|
why
|
|
-------
|
|
Etherdump is useful as a means of dumping the contents of etherpad to files, as a way of opening up the contents of the service to other services / methods / uses / tools / situations. (Files also of course allow for archival tools / methods)
|
|
|