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


Requirements
-------------
Michael Murtaugh's avatar
Michael Murtaugh committed
9
	* python3
Michael Murtaugh's avatar
Michael Murtaugh committed
10
	* html5lib
11
	* requests (settext)
12
	* python-dateutil, jinja2 (index subcommand)
Michael Murtaugh's avatar
Michael Murtaugh committed
13

Michael Murtaugh's avatar
readme    
Michael Murtaugh committed
14
15
16
Installation
-------------

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

Michael Murtaugh's avatar
Michael Murtaugh committed
20
21
22
23
24
25
26
Example
---------------
	mkdir mydump
	cd myddump
	etherdump init

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

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

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



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

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

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

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

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

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)
67

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

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)
Michael Murtaugh's avatar
Michael Murtaugh committed
76
77
78
79
80
81

Jan 2018
-------------
Updated files to work with python3 (probably this has broken python2).