Commit 0d170b25 authored by Michael Murtaugh's avatar Michael Murtaugh

better doc

parent 117430b3
......@@ -2,3 +2,4 @@ venv/
sites/
*.pyc
*~
padinfo.json
......@@ -17,3 +17,28 @@ Installation
pip install html5lib jinja2
Padinfo file
-------------
The easiest way to use etherdump is to create a padinfo JSON file that contains all the information necessary to connect to a particular etherpad server (including hostname, port, and API key).
cp padinfo.sample.json padinfo.json
nano padinfo.json
And then...
etherdump --padinfo padinfo.json list
listpads
----------
To dump the names of the pads in JSON format:
./etherdump --padinfo padinfo.json listpads
./etherdump --padinfo padinfo.json listpads > pads.json
To format for the screen add the --lines option:
./etherdump --padinfo padinfo.json listpads --lines
......@@ -11,6 +11,7 @@ from datetime import datetime
PADINFO_DEFAULTS = {
"hostname": "",
"port": 9001,
"apiversion": "1.2.9",
"apiurl": "/api/"
}
......@@ -326,8 +327,7 @@ if __name__ == "__main__":
apikey=padinfo.get("apikey")
)
if verbose:
print ("Connecting to {0}".format(padserver.apiurl), file=sys.stderr)
print ("Connecting to {0}".format(padserver.apiurl), file=sys.stderr)
###############################
# Command Dispatch
......
{
"hostname": "localhost",
"port": 9001,
"apiurl": "/api/",
"apiversion": "1.2.9",
"apikey": "XXXXXXXXXXXXXXXXXXXXXXXXX"
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment