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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file etherpad_lite-0.5.tar.gz.

File metadata

File hashes

Hashes for etherpad_lite-0.5.tar.gz
Algorithm Hash digest
SHA256 07ca67f3f8d0342e9a114f96b908ec055a5c6d23f59bb0cbf5e06e4a06bbdae3
MD5 0a1635f7a11cce33d86a041dac89e8b6
BLAKE2b-256 136c2079dac77d480fd49862d12465ed3369360ad9b8c9bb0e3fb79f1e7b650e

See more details on using hashes here.

File details

Details for the file etherpad_lite-0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for etherpad_lite-0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 80844f198a89d355cb39c18aee15f7fa641d67330487b20d4caa6cc498c1d818
MD5 06086090d62b1e6b0afc5303bfc95a93
BLAKE2b-256 1a89cdba92ddfc894d664ba68fb55fcc547736165e096c594d3d6ab94d66c19b

See more details on using hashes here.

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