pppadump/README.md
2016-10-17 15:40:16 +02:00

66 lines
1.2 KiB
Markdown

etherdump
=========
Tool to publish [etherpad](http://etherpad.org/) pages to files.
Requirements
-------------
* html5lib
* python-datutil, jinja2 (index subcommand)
Installation
-------------
pip install python-dateutil jinja2 html5lib
python setup.py install
Example
---------------
mkdir mydump
cd myddump
etherdump init
The program then interactively asks some questions:
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
The settings are placed in a file called .etherdump/settings.json and are used (by default) by future commands.
subcommands
----------
* init
* pull
* list
* listauthors
* gettext
* gethtml
* creatediffhtml
* revisionscount
* index
To get help on a subcommand:
etherdump revisionscount --help
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)