Changeset 35 for pkipplib/trunk

Timestamp:

06/24/06 15:56:24 (18 years ago)

Author:

jerome

Message:

Documents samplenotifier.

Location:

pkipplib/trunk

Files:

• notifiers (added)
• notifiers/samplenotifier (added)
• pkipplib/pkipplib.py (modified) (2 diffs)
• README (modified) (2 diffs)

pkipplib/trunk/pkipplib/pkipplib.py

@@ -716 +716 @@
                                       timeinterval=None,
                                       jobid=None) :
-        """Creates a job, printer or server subscription."""
+        """Creates a job, printer or server subscription.
+         
+           uri : the subscription's uri, e.g. ipp://server
+           events : a list of events to subscribe to, e.g. ["printer-added", "printer-deleted"]
+           recipient : the notifier's uri
+           pullmethod : the pull method to use
+           charset : the charset to use when sending notifications
+           naturallanguage : the language to use when sending notifications
+           leaseduration : the duration of the lease in seconds
+           timeinterval : the interval of time during notifications
+           jobid : the optional job id in case of a job subscription
+        """   
         if jobid is not None :
             opid = IPP_CREATE_JOB_SUBSCRIPTION
@@ -746 +757 @@
             
     def cancelSubscription(self, uri, subscriptionid, jobid=None) :    
-        """Cancels a subscription."""
+        """Cancels a subscription.
+        
+           uri : the subscription's uri.
+           subscriptionid : the subscription's id.
+           jobid : the optional job's id.
+        """
         req = self.newRequest(IPP_CANCEL_SUBSCRIPTION)
         if jobid is not None :

pkipplib/trunk/README

@@ -142 +142 @@
   pkipplib currently includes the following command line tools :
   
-        - pksubscribe : can create or delete IPP subscriptions.
+    * pksubscribe : can create or delete IPP subscriptions.
+    
           See pksubscribe --help for details.
         
@@ -155 +156 @@
                           --password HacKMe \
                           --delete 34 58 98
+                          
+    * samplenotifier : can handle printer-added and printer-deleted
+      notifications and automatically create or remove printers
+      from PyKota's database (just adapt the code for other needs).
+      
+      samplenotifier is present in the notifiers/ directory, but
+      won't be installed automatically.
 
   In the future more command line tools will be included.