@@ -14,9 +14,10 @@ will then check a system level configuration file at: The configuration parameters used by the library are as follows: [Credentials] - username = <phanfare username> - password = <phanfare password> - api_key = <phanfare api key> + email = <phanfare email address> + password = <phanfare password> + api_key = <phanfare api key> + private_key = <phanfare secret key> [General] api_url = http://api.phanfare.com/rest/?method= docs/configuration.txt @@ -6,6 +6,8 @@ should model Phanfare entities and follow good OOD principles such as loose coupling, separation of concerns, dependency injection (mainly for testability). +Based on the [Phanfare 2.0 API](http://help.phanfare.com/index.php/API). + ## pyphanfare.connection.PhanfareConnection This is the object that all HTTP communication flows through. It should have @@ -13,9 +15,6 @@ functions that other objects can execute HTTP requests through and provides session and authentication functions. It has the following methods: * PhanfareConnection.authenticate() - **Authenticate** -* PhanfareConnection.new\_account(email\_address, first\_name, last\_name, promo\code=None) - **NewAccount** -* PhanfareConnection.get\_my\_relations() - **GetMyRelations** -* PhanfareConnection.get\_albums(user\_id=None) - **GetAlbumList** In addition to this API methods, the PhanfareConnection class will contain an instance method that handles the query string generation cruft. The caller @@ -26,6 +25,15 @@ should only need to supply the method name, and a dictionary of parameters: This function returns an xml-dom object for the caller to parse and make use of. +## pyphanfare.models.Account + +This model represents a Phanfare account, either the authenticated user's or +their friends or family members. + +* Account.get\_relations() - **GetMyRelations** +* Account.save\_new(promo\_code=None) - **NewAccount** +* Account.get\_albums() - **GetAlbumList** + ## pyphanfare.models.Album This model represents the basic Album in Phanfare and contains the following @@ -43,7 +51,7 @@ methods/properties: This model represents a section with an album and contains the following methods: -* Section.\_\_init\_\_(connection) +* Section.\_\_init\_\_(connection, section\_xml) * Section.save() - **NewSection** or **UpdateSection** * Section.delete() - **DeleteSection** * Section.send\_image(filename, caption="", is\_video=False, hidden=False, image\_date=None) - **NewImage** docs/object_design.txt 0b82d282fe9811db7de8354557515865be3c73bc Patrick Altman paltman@gmail.com http://github.com/paltman/pyphanfare/commit/e37d14e75631be6a93ca8ca688d0bec628ce715e e37d14e75631be6a93ca8ca688d0bec628ce715e 2008-04-24T22:26:03-07:00 2008-04-24T22:26:03-07:00 updated docs c45842876d0d3651bd3faa1b96a648415a80f6c3 Patrick Altman paltman@gmail.com