README.md 1.64 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
	* html5lib
11
	* requests (settext)
Michael Murtaugh's avatar
Michael Murtaugh committed
12
	* python-datutil, jinja2 (index subcommand)
Michael Murtaugh's avatar
Michael Murtaugh committed
13

Michael Murtaugh's avatar
readme  
Michael Murtaugh committed
14 15 16 17

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

Michael Murtaugh's avatar
Michael Murtaugh committed
18
    pip install python-dateutil jinja2 html5lib
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 23 24 25 26 27
Example
---------------
	mkdir mydump
	cd myddump
	etherdump init

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

Michael Murtaugh's avatar
Michael Murtaugh committed
29 30 31 32 33
	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
34

Michael Murtaugh's avatar
Michael Murtaugh committed
35
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
36 37 38



Michael Murtaugh's avatar
Michael Murtaugh committed
39
subcommands
Michael Murtaugh's avatar
Michael Murtaugh committed
40 41
----------

Michael Murtaugh's avatar
Michael Murtaugh committed
42 43
* init
* pull
Michael Murtaugh's avatar
Michael Murtaugh committed
44 45
* list
* listauthors
Michael Murtaugh's avatar
Michael Murtaugh committed
46
* gettext
Michael Murtaugh's avatar
readme  
Michael Murtaugh committed
47
* settext
Michael Murtaugh's avatar
Michael Murtaugh committed
48 49
* gethtml
* creatediffhtml
Michael Murtaugh's avatar
Michael Murtaugh committed
50
* revisionscount
Michael Murtaugh's avatar
Michael Murtaugh committed
51
* index
Michael Murtaugh's avatar
readme  
Michael Murtaugh committed
52
* deletepad
Michael Murtaugh's avatar
Michael Murtaugh committed
53

Michael Murtaugh's avatar
Michael Murtaugh committed
54
To get help on a subcommand:
Michael Murtaugh's avatar
Michael Murtaugh committed
55

Michael Murtaugh's avatar
Michael Murtaugh committed
56
	etherdump revisionscount --help
Michael Murtaugh's avatar
Michael Murtaugh committed
57

Michael Murtaugh's avatar
Michael Murtaugh committed
58 59 60 61 62 63 64 65 66 67

Change log / notes
=======================

Originally designed for use at: [constant](http://etherdump.constantvzw.org/).


17 Oct 2016
-----------------------------------------------
Preparations for [Machine Research](https://machineresearch.wordpress.com/) [2](http://constantvzw.org/site/Machine-Research,2646.html)
68

Michael Murtaugh's avatar
python3  
Michael Murtaugh committed
69 70 71 72 73 74 75 76

6 Oct 2017
----------------------
Feature request from PW: When deleting a previously public document, generate a page / pages with an explanation (along the lines of "This document was previously public but has been marked .... maybe give links to search").

3 Nov 2017
---------------
machineresearch seems to be __NOPUBLISH__ but still exists (also in recentchanges)