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.

59 lines
1.3 KiB

9 years ago
etherdump
=========
Tool to publish [etherpad](http://etherpad.org/) pages to files.
Requirements
-------------
None beyond standard lib.
9 years ago
Installation
-------------
9 years ago
python setup.py install
9 years ago
9 years ago
Padinfo file
-------------
9 years ago
All pad-specific settings are loaded from a file called "padinfo.json" -- by default etherdump looks in the current directory. Make a copy of padinfo.sample.json to start one. Make sure to check that the URL and port settings are correct, and to paste the correct apikey here!
9 years ago
9 years ago
cp padinfo.sample.json ~/yourfolder/padinfo.json
9 years ago
nano padinfo.json
And then for instance:
9 years ago
9 years ago
etherdump list
9 years ago
9 years ago
subcommands
9 years ago
----------
* sync
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)