diff --git a/README b/README.md similarity index 77% rename from README rename to README.md index 485f56d..36f918b 100644 --- a/README +++ b/README.md @@ -1,9 +1,8 @@ -pandora_client - python client and libary to access a pan.do/ra instances +# pandora_client - python client and libary to access a pan.do/ra instances -For more info on using pandora_client, check -http://wiki.0x2620.org/wiki/pandora_client -pandora client example: +## pandora client example: + import pandora_client #example config.json ''' @@ -24,7 +23,8 @@ pandora client example: c.clean() #cleanup transcodes created druing sync to save disk space -just using the API: +## just using the API: + api = pandora_client.API("http://localhost:8000/api/") r = api.find( query={'conditions':[]}, @@ -40,17 +40,18 @@ i.e. in ipython: (alternatively you can open the api url in a browser to read further documentation) -== Distributed encoding == +## Distributed encoding + pandora_client can distribute the encoding to multiple nodes on a local network or multiple encodings on the same host. to do this you need to install additional dependencies: - apt-get install python-twisted python-requests - (on ubuntu 12.04 you need a newer version of requests, - i.e: sudo easy_install -U requests) + apt-get install python3-twisted python3-requests now run one node in server mode: + pandora_client server and start the other nodes with: + pandora_client client http://SERVER_IP:8789