# API version
The supported API version is [1.3.0](https://etherpad.org/doc/v2.1.1/index.html#_http_api)
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
```shell
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:
```shell
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
```python
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](https://etherpad.org/doc/v2.1.1/]) 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](https://github.com/devjones/PyEtherpadLite) and is inspired by [TomNomNom's php client](https://github.com/TomNomNom/etherpad-lite-client)
Raw data
{
"_id": null,
"home_page": "https://github.com/Alienmaster/PyEtherpadLite",
"name": "pyetherpadlite",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "alienmaster, devjones",
"author_email": "github@crpykng.de",
"download_url": "https://files.pythonhosted.org/packages/7b/73/aaeef1bca167dee38a7b53ddc5c3ab2b8eee349518be97ba5bb769cb1b4b/pyetherpadlite-1.2.tar.gz",
"platform": "any",
"description": "# API version\nThe supported API version is [1.3.0](https://etherpad.org/doc/v2.1.1/index.html#_http_api)\n\nThis python api enables easy interaction with the Etherpad API. Etherpad is a collaborative editor provided by the Etherpad Foundation. http://etherpad.org\n\n# 1 Installation\n\n```shell\npip install pyetherpadlite\n```\n\n# 2 Preparation\n\nIf 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).\n\nYour 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:\n \n```shell\necho -n \"myapikey\" > APIKEY.txt\n```\n\nOnce 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.\n\n# 3 Basic usage\n\n```python\nfrom py_etherpad import EtherpadLiteClient\nmyPad = EtherpadLiteClient('EtherpadFTW','http://beta.etherpad.org/api')\n# Change the text of the etherpad\nmyPad.setText('testPad','New text from the python wrapper!')\n```\n\n# 4 More details\n\nSee the `src/py_etherpad/__init__.py` file for further details on the methods and parameters available for the API.\nNearly all calls from the [official API](https://etherpad.org/doc/v2.1.1/]) work as in the official documentation described.\n\n# 5 Test coverage\n\nActually im writing the tests for each topic.\n\nAlready finished:\n- Groups\n- Pads\n\nNearly finished:\n- Author\n\n# 6 License\n\nApache License\n\n# 7 Credit\nThis python API-Wrapper is a Fork from [devjones](https://github.com/devjones/PyEtherpadLite) and is inspired by [TomNomNom's php client](https://github.com/TomNomNom/etherpad-lite-client)\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Python bindings for Etherpad's HTTP API. (https://github.com/ether/etherpad-lite)",
"version": "1.2",
"project_urls": {
"Bug Tracker": "https://github.com/Alienmaster/PyEtherpadLite/issues",
"Homepage": "https://github.com/Alienmaster/PyEtherpadLite",
"Source Code": "https://github.com/Alienmaster/PyEtherpadLite"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e74d5d3588927d1df219143be9df7ee6e0d307a032422f96ad33846c579c3784",
"md5": "a33ab2fedfcdf8ff07e2dccdef9faec5",
"sha256": "5850e85ef68dec77ca49648c60c98856fe844fe624dfea66bc3d3f8567389570"
},
"downloads": -1,
"filename": "pyetherpadlite-1.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a33ab2fedfcdf8ff07e2dccdef9faec5",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 6223,
"upload_time": "2024-08-05T15:23:03",
"upload_time_iso_8601": "2024-08-05T15:23:03.036543Z",
"url": "https://files.pythonhosted.org/packages/e7/4d/5d3588927d1df219143be9df7ee6e0d307a032422f96ad33846c579c3784/pyetherpadlite-1.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7b73aaeef1bca167dee38a7b53ddc5c3ab2b8eee349518be97ba5bb769cb1b4b",
"md5": "ff207be495d9511c749797c6b8b7357d",
"sha256": "2042f19717fc90620f51eca7bdd87140abdaf3c2ee958280ef1c0257c9902d4a"
},
"downloads": -1,
"filename": "pyetherpadlite-1.2.tar.gz",
"has_sig": false,
"md5_digest": "ff207be495d9511c749797c6b8b7357d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6201,
"upload_time": "2024-08-05T15:23:04",
"upload_time_iso_8601": "2024-08-05T15:23:04.072744Z",
"url": "https://files.pythonhosted.org/packages/7b/73/aaeef1bca167dee38a7b53ddc5c3ab2b8eee349518be97ba5bb769cb1b4b/pyetherpadlite-1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-05 15:23:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Alienmaster",
"github_project": "PyEtherpadLite",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyetherpadlite"
}
JSON
