README.md 870 Bytes
Newer Older
Michael Murtaugh's avatar
Michael Murtaugh committed
1 2 3
etherdump
=========

Michael Murtaugh's avatar
Michael Murtaugh committed
4 5 6 7 8 9 10 11 12 13
Tool to publish [etherpad](http://etherpad.org/) pages to (archival) HTML.


Requirements
-------------

Python (2.7) with:

* html5lib
* jinja2
Michael Murtaugh's avatar
readme  
Michael Murtaugh committed
14 15 16 17 18 19

Installation
-------------

    pip install html5lib jinja2

Michael Murtaugh's avatar
Michael Murtaugh committed
20 21 22 23 24 25 26
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

Michael Murtaugh's avatar
Michael Murtaugh committed
27
And then for instance:
Michael Murtaugh's avatar
Michael Murtaugh committed
28

Michael Murtaugh's avatar
Michael Murtaugh committed
29
    etherdump --padinfo padinfo.json listpads
Michael Murtaugh's avatar
Michael Murtaugh committed
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44


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