Skip to content

Commit

Permalink
Merge pull request #1 from ozkatz/master
Browse files Browse the repository at this point in the history
installation using PIP
  • Loading branch information
devjones committed Sep 18, 2011
2 parents 2edb585 + fdfc20a commit 888e2e5
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
This python api enables easy interaction with the Etherpad Lite API. Etherpad Lite is a collaborative editor provided by the Etherpad Foundation. http://etherpad.org

#1 Installation

#1 Preparation
To install py_etherpad using PIP, add the following line to your requirements.txt file:

-e git+git://github.com/ozkatz/PyEtherpadLite.git#egg=PyEtherpadLite

#2 Preparation

If you are using a self hosted Etherpad Lite server, you will need to specify an API Key after installation before using the API. (See https://github.com/Pita/etherpad-lite for installation details).

Expand All @@ -11,21 +16,21 @@ Your secret api key should be placed in the base installation (etherpad-client f

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.

#2 Basic usage
#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!')

#3 More details
#4 More details

See the py_etherpad.py file for further details on the methods and parameters available for the API

#3 License
#5 License

Apache License

#4 Credit
#6 Credit
This python client was inspired by TomNomNom's php client which can be found at: https://github.com/TomNomNom/etherpad-lite-client
16 changes: 16 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
from distutils.core import setup

setup(
name='PyEtherpadLite',
version='0.1',
description='Python bindings for Etherpad-Lite\'s HTTP API. (https://github.com/Pita/etherpad-lite)',
author='devjones',
url='https://github.com/devjones/PyEtherpadLite',
package_dir={'': 'src'},
py_modules=[
'PyEtherpadLite',
],
)

File renamed without changes.

0 comments on commit 888e2e5

Please sign in to comment.