Permalink
Browse files

added pip installation section

  • Loading branch information...
1 parent 69c5f32 commit fdfc20a50cbd6b72fedce74a9d3140a7eded4987 @ozkatz ozkatz committed Sep 4, 2011
Showing with 10 additions and 5 deletions.
  1. +10 −5 README.md
View
@@ -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).
@@ -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

0 comments on commit fdfc20a

Please sign in to comment.