README.md 1.08 KB
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

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

    pip install html5lib jinja2
Michael Murtaugh's avatar
Michael Murtaugh committed
19
    python setup.py install
Michael Murtaugh's avatar
readme  
Michael Murtaugh committed
20

Michael Murtaugh's avatar
Michael Murtaugh committed
21 22
Padinfo file
-------------
Michael Murtaugh's avatar
Michael Murtaugh committed
23
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!
Michael Murtaugh's avatar
Michael Murtaugh committed
24

Michael Murtaugh's avatar
Michael Murtaugh committed
25
    cp padinfo.sample.json ~/yourfolder/padinfo.json
Michael Murtaugh's avatar
Michael Murtaugh committed
26 27
    nano padinfo.json

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

Michael Murtaugh's avatar
Michael Murtaugh committed
30
    etherdump list
Michael Murtaugh's avatar
Michael Murtaugh committed
31 32


Michael Murtaugh's avatar
Michael Murtaugh committed
33
subcommands
Michael Murtaugh's avatar
Michael Murtaugh committed
34 35
----------

Michael Murtaugh's avatar
Michael Murtaugh committed
36 37 38 39 40 41
* dump (the default)
* list
* listauthors
* text
* diffhtml
* revisionscount
Michael Murtaugh's avatar
Michael Murtaugh committed
42

Michael Murtaugh's avatar
Michael Murtaugh committed
43
To get help on a subcommand:
Michael Murtaugh's avatar
Michael Murtaugh committed
44

Michael Murtaugh's avatar
Michael Murtaugh committed
45
	etherdump revisionscount --help
Michael Murtaugh's avatar
Michael Murtaugh committed
46 47 48 49 50 51 52 53

TODO
--------
* Modify tools to work with make
** Sync command
** Dump command that works on a single page
** Post processing as separable filters (such as linkify)
* Support for migrating (what dump formats exist that would allow pushing to another instance?)