API version
The supported API version is 1.3.0
This python api enables easy interaction with the Etherpad API. Etherpad is a collaborative editor provided by the Etherpad Foundation. http://etherpad.org
1 Installation
pip install pyetherpadlite
2 Preparation
If you are using a self hosted Etherpad server, you will need to specify an API Key after installation before using the API. (See https://github.com/ether/etherpad-lite for installation details).
Your secret api key should be placed in the base installation (etherpad-client folder) in a text file named APIKEY.txt. Many linux text editors automatically create an extra newline character at the end of the file, so I recommend simply executing the following command to set your api key without a newline character:
echo -n "myapikey" > APIKEY.txt
Once you have created the APIKEY.txt file, you will need to edit the py_etherpad.py wrapper to set your API key. Edit the 'apiKey' variable and set it to the same key as defined in your APIKEY.txt file.
3 Basic usage
from py_etherpad import EtherpadLiteClient
myPad = EtherpadLiteClient('EtherpadFTW','http://beta.etherpad.org/api')
# Change the text of the etherpad
myPad.setText('testPad','New text from the python wrapper!')
4 More details
See the src/py_etherpad/__init__.py file for further details on the methods and parameters available for the API.
Nearly all calls from the official API work as in the official documentation described.
5 Test coverage
Actually im writing the tests for each topic.
Already finished:
- Groups
- Pads
Nearly finished:
- Author
6 License
Apache License
7 Credit
This python API-Wrapper is a Fork from devjones and is inspired by TomNomNom's php client
Metadata
Release files for pyetherpadlite 1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pyetherpadlite-1.2.tar.gz | 6.2 kB | Without provenance | Details for pyetherpadlite-1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyetherpadlite-1.2-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for pyetherpadlite-1.2-py2.py3-none-any.whl |
Total release size: 12.4 kB
Release files / pyetherpadlite-1.2.tar.gz
| Download URL | pyetherpadlite-1.2.tar.gz |
|---|---|
| Size | 6.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2042f19717fc90620f51eca7bdd87140abdaf3c2ee958280ef1c0257c9902d4a
|
|
BLAKE2b-256 checksum How to use checksums |
7b73aaeef1bca167dee38a7b53ddc5c3ab2b8eee349518be97ba5bb769cb1b4b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.12
|
Release files / pyetherpadlite-1.2-py2.py3-none-any.whl
| Download URL | pyetherpadlite-1.2-py2.py3-none-any.whl |
|---|---|
| Size | 6.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
5850e85ef68dec77ca49648c60c98856fe844fe624dfea66bc3d3f8567389570
|
|
BLAKE2b-256 checksum How to use checksums |
e74d5d3588927d1df219143be9df7ee6e0d307a032422f96ad33846c579c3784
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.12
|
Security for pyetherpadlite 1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.