Pumping pads as files into publishing frameworks!
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

69 lines
1.4 KiB

9 years ago
etherdump
=========
Tool to publish [etherpad](http://etherpad.org/) pages to files.
Requirements
-------------
python-dateutil, html5lib
9 years ago
Installation
-------------
pip install python-dateutil html5lib
9 years ago
python setup.py install
9 years ago
Example
---------------
mkdir mydump
cd myddump
etherdump init
The program then interactively asks some questions:
9 years ago
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
9 years ago
The settings are placed in a file called .etherdump/settings.json and are used (by default) by future commands.
9 years ago
9 years ago
subcommands
9 years ago
----------
* init
* pull
9 years ago
* list
* listauthors
* gettext
* gethtml
* creatediffhtml
9 years ago
* revisionscount
9 years ago
9 years ago
To get help on a subcommand:
9 years ago
9 years ago
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)