README.md 1.25 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
-------------

Michael Murtaugh's avatar
Michael Murtaugh committed
10
None beyond standard lib.
Michael Murtaugh's avatar
Michael Murtaugh committed
11

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

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

Michael Murtaugh's avatar
Michael Murtaugh committed
16
    python setup.py install
Michael Murtaugh's avatar
readme  
Michael Murtaugh committed
17

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

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

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

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


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

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

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

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

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

57 58 59
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)