|
1 Metadata-Version: 1.1 |
|
2 Name: pyams-scheduler |
|
3 Version: 0.1.0 |
|
4 Summary: PyAMS tasks scheduler |
|
5 Home-page: http://hg.ztfy.org/pyams/pyams_scheduler |
|
6 Author: Thierry Florac |
|
7 Author-email: tflorac@ulthar.net |
|
8 License: ZPL |
|
9 Description: ======================= |
|
10 pyams_scheduler package |
|
11 ======================= |
|
12 |
|
13 .. contents:: |
|
14 |
|
15 What is pyams_scheduler? |
|
16 ======================== |
|
17 |
|
18 pyams_scheduler is a package which is part of the PyAMS framework and is targeted to the Pyramid environment. |
|
19 |
|
20 This package allows to define tasks which will be scheduled and run asynchronously on a regular basis. |
|
21 |
|
22 Scheduling is based on the APScheduler package, and tasks can be scheduled using cron-style, "at" or interval |
|
23 based scheduling settings. But tasks definitions are stored in the ZODB and they can be managed easily through |
|
24 a simple web interface; synchronisation between the web process and the scheduler background process is done |
|
25 using ØMQ messages. |
|
26 |
|
27 Tasks can keep an history log in the ZODB; these logs can also be sent by mail, on each run or when errors |
|
28 are detected. |
|
29 |
|
30 |
|
31 Starting scheduler |
|
32 ================== |
|
33 |
|
34 The APScheduler process is started automatically on package include. |
|
35 |
|
36 The only thing you have to do is to create an application setting in your INI file, like this: |
|
37 |
|
38 pyams_scheduler.tcp_handler = 127.0.0.1:5555 |
|
39 |
|
40 This will define the address and port of the listening ØMQ process. Without this setting, the scheduler won't |
|
41 be started. |
|
42 |
|
43 |
|
44 Adding tasks |
|
45 ============ |
|
46 |
|
47 Three task types are defined into PyAMS scheduler package: |
|
48 |
|
49 - an URL caller task, which can be used to call any HTTP based URL |
|
50 |
|
51 - an SSH command task, which can be used to start local or remote commands |
|
52 |
|
53 - a ZODB packing task, which can be used to pack a ZODB. |
|
54 |
|
55 You can also register and add your own tasks, which will be added through PyAMS management interface. |
|
56 |
|
57 Each task as a set of common properties which are used to name the task, define the scheduling mode and reports |
|
58 management and activate and schedule the task, as well as settings specific to the given task. |
|
59 |
|
60 |
|
61 |
|
62 Keywords: Pyramid PyAMS scheduler |
|
63 Platform: UNKNOWN |
|
64 Classifier: License :: OSI Approved :: Zope Public License |
|
65 Classifier: Development Status :: 4 - Beta |
|
66 Classifier: Programming Language :: Python |
|
67 Classifier: Framework :: Pyramid |
|
68 Classifier: Topic :: Software Development :: Libraries :: Python Modules |