README.md 1.35 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 21 22 23 24 25
Example
---------------
	mkdir mydump
	cd myddump
	etherdump init

The program then interactively asks some questions:
Michael Murtaugh's avatar
Michael Murtaugh committed
26

Michael Murtaugh's avatar
Michael Murtaugh committed
27 28 29 30 31
	Please type the URL of the etherpad: 
		http://automatist.local:9001/
	The APIKEY is the contents of the file APIKEY.txt in the etherpad folder
	Please paste the APIKEY: 
		xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Michael Murtaugh's avatar
Michael Murtaugh committed
32

Michael Murtaugh's avatar
Michael Murtaugh committed
33
The settings are placed in a file called .etherdump/settings.json and are used (by default) by future commands.
Michael Murtaugh's avatar
Michael Murtaugh committed
34 35 36



Michael Murtaugh's avatar
Michael Murtaugh committed
37
subcommands
Michael Murtaugh's avatar
Michael Murtaugh committed
38 39
----------

Michael Murtaugh's avatar
Michael Murtaugh committed
40 41
* init
* pull
Michael Murtaugh's avatar
Michael Murtaugh committed
42 43
* list
* listauthors
Michael Murtaugh's avatar
Michael Murtaugh committed
44 45 46
* gettext
* gethtml
* creatediffhtml
Michael Murtaugh's avatar
Michael Murtaugh committed
47
* revisionscount
Michael Murtaugh's avatar
Michael Murtaugh committed
48

Michael Murtaugh's avatar
Michael Murtaugh committed
49
To get help on a subcommand:
Michael Murtaugh's avatar
Michael Murtaugh committed
50

Michael Murtaugh's avatar
Michael Murtaugh committed
51
	etherdump revisionscount --help
Michael Murtaugh's avatar
Michael Murtaugh committed
52

53 54 55 56 57 58 59 60 61 62 63 64
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

65 66
why
-------
67 68
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)