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

Michael Murtaugh's avatar
Michael Murtaugh committed
4
Tool to publish [etherpad](http://etherpad.org/) pages to files.
Michael Murtaugh's avatar
Michael Murtaugh committed
5 6 7 8 9


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

10
python-dateutil, html5lib
Michael Murtaugh's avatar
Michael Murtaugh committed
11

Michael Murtaugh's avatar
readme  
Michael Murtaugh committed
12 13 14 15

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

16
    pip install python-dateutil html5lib
Michael Murtaugh's avatar
Michael Murtaugh committed
17
    python setup.py install
Michael Murtaugh's avatar
readme  
Michael Murtaugh committed
18

Michael Murtaugh's avatar
Michael Murtaugh committed
19 20
Padinfo file
-------------
Michael Murtaugh's avatar
Michael Murtaugh committed
21
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
22

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

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

Michael Murtaugh's avatar
Michael Murtaugh committed
28
    etherdump list
Michael Murtaugh's avatar
Michael Murtaugh committed
29 30


Michael Murtaugh's avatar
Michael Murtaugh committed
31
subcommands
Michael Murtaugh's avatar
Michael Murtaugh committed
32 33
----------

Michael Murtaugh's avatar
Michael Murtaugh committed
34
* sync
Michael Murtaugh's avatar
Michael Murtaugh committed
35 36
* list
* listauthors
Michael Murtaugh's avatar
Michael Murtaugh committed
37 38 39
* gettext
* gethtml
* creatediffhtml
Michael Murtaugh's avatar
Michael Murtaugh committed
40
* revisionscount
Michael Murtaugh's avatar
Michael Murtaugh committed
41

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

Michael Murtaugh's avatar
Michael Murtaugh committed
44
	etherdump revisionscount --help
Michael Murtaugh's avatar
Michael Murtaugh committed
45

46 47 48 49 50 51 52 53 54 55 56 57
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

58 59
why
-------
60 61
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)