Skip to main content

Python interface for Etherpad-Lite's HTTP API

Project description

Etherpad Lite is a web service that allows real-time document collaboration for groups of users. http://etherpad.org/

python-etherpad_lite provides an interface for Etherpad-Lite’s HTTP API.

Installation

pip install etherpad_lite

python-etherpad_lite doesn’t have dependencies and is compatible with both python 2 and 3.

Usage

From python:

from etherpad_lite import EtherpadLiteClient
c = EtherpadLiteClient(base_params={'apikey':'secret_from_APIKEY.txt'})
c.createPad(padID='test', text="Lorem ipsum dolor sit amet.")

From the command line:

$ python -m etherpad_lite -p apikey=secret_from_APIKEY.txt
=> Welcome to the Etherpad Lite shell !
=> Command example: createPad padID=test text="Lorem ipsum dolor sit amet."
% createPad padID=test text="Lorem ipsum dolor sit amet."
ok
% getHTML padID=test
{u'html': u'Lorem ipsum dolor sit amet.<br>'}
% deletePad padID=test
ok

See the documentation of Etherpad Lite for the list of API functions and their arguments.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for etherpad_lite, version 0.5
Filename, size File type Python version Upload date Hashes
Filename, size etherpad_lite-0.5-py3-none-any.whl (4.5 kB) File type Wheel Python version 3.5 Upload date Hashes View hashes
Filename, size etherpad_lite-0.5.tar.gz (3.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page