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.

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 3 5

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page