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.

License

CC0 Public Domain Dedication

Project details


Download files

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

Source Distribution

etherpad_lite-0.5.tar.gz (3.6 kB view hashes)

Uploaded Source

Built Distribution

etherpad_lite-0.5-py3-none-any.whl (4.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page