Changes between Version 14 and Version 15 of JobControlPlugin

Timestamp:

Apr 5, 2022, 6:10:02 AM (2 years ago)

Author:

figaro

Comment:

Move example to functional description

JobControlPlugin

@@ -10 +10 @@
 
 The plugin lets you set up and manage and monitor scheduled jobs. It adds the following new Admin screens to Trac: 
- * Job Admin - List and lets you add, edit and delete jobs. 
- * Job Status Map - Where you can see the status of the last run of all the jobs. From here you can drill down to the run view of a particular job. 
+ * Job Admin - Lists all jobs and lets you add, edit and delete jobs. 
+ * Job Status Map - See the status of the last run of all the jobs. From here you can drill down to the run view of a particular job. 
  * Run View - Lists all job runs, showing you the runs status form where you can drill down to the runs log. 
  * Log Admin - Clean-up logs and other tasks. 
@@ -24 +24 @@
 
 [[Image(jobcontrol-jobedit.png)]]
+
+Here is an example of a job configuration:
+{{{#!python
+from jobcontrolplugin import JobSpec, today
+
+from logging import DEBUG
+
+class MyJob(JobSpec):
+    """
+    Run this script with logging in debug mode.
+    Run every 45 minutes.
+    Run /usr/local/etc/myscript at yesterday's date as a command argument.
+    """
+    grouping = "/All Jobs/Tests"
+    log_level = DEBUG
+    cron = "* * * 45";
+    cmd = "/usr/local/etc/myscript --date=%s"; % today(-1)
+    run = "runA, runB";
+
+    def setUp(self):
+        pass
+    def tearDown(self):
+        pass
+    def runA(self): pass
+
+    @dependsOn(runA)
+    def runB(self): pass
+
+MyJob.run()
+}}}
+
+Then check it in and make the Job record point to it:
+
+||'''Job Id'''||'''Last Run'''||'''Status'''||'''Next Run'''||'''Configuration'''||
+||My Job||  12:45 Today || 13:00 Today || OK || [# http://trac-hacks.org/browser/myjob.py?rev=6077]||
 
 == Bugs/Feature Requests
@@ -45 +80 @@
 This plugin is not yet available for Trac version 0.12 and above. 
 
-== Example
-
-Here is an example of a job configuration:
-{{{#!python
-from jobcontrolplugin import JobSpec, today
-
-from logging import DEBUG
-
-class MyJob(JobSpec):
-    """
-    Run this script with logging in debug mode.
-    Run every 45 minutes.
-    Run /usr/local/etc/myscript at yesterday's date as a command argument.
-    """
-    grouping="/All Jobs/Tests"
-    log_level=DEBUG
-    cron="* * * 45";
-    cmd ="/usr/local/etc/myscript --date=%s"; % today(-1)
-    run= "runA, runB";
-
-    def setUp(self):
-        pass
-    def tearDown(self):
-        pass
-    def runA(self): pass
-
-    @dependsOn(runA)
-    def runB(self): pass
-
-MyJob.run()
-}}}
-
-You would check it in and make the Job record point to it:
-
-||'''Job Id'''||'''Last Run'''||'''Status'''||'''Next Run'''||'''Configuration'''||
-||My Job||  12:45 Today || 13:00 Today || OK || [# http://trac-hacks.org/browser/myjob.py?rev=6077]||
-
 == Recent Changes