pppadump/README.md
Michael Murtaugh 0d170b25f1 better doc
2015-06-18 14:56:48 +02:00

45 lines
855 B
Markdown

etherdump
=========
Tool to publish [etherpad](http://etherpad.org/) pages to (archival) HTML.
Requirements
-------------
Python (2.7) with:
* html5lib
* jinja2
Installation
-------------
pip install html5lib jinja2
Padinfo file
-------------
The easiest way to use etherdump is to create a padinfo JSON file that contains all the information necessary to connect to a particular etherpad server (including hostname, port, and API key).
cp padinfo.sample.json padinfo.json
nano padinfo.json
And then...
etherdump --padinfo padinfo.json list
listpads
----------
To dump the names of the pads in JSON format:
./etherdump --padinfo padinfo.json listpads
./etherdump --padinfo padinfo.json listpads > pads.json
To format for the screen add the --lines option:
./etherdump --padinfo padinfo.json listpads --lines