README.rst
1.. image:: https://travis-ci.com/agronholm/apscheduler.svg?branch=3.x
2 :target: https://travis-ci.com/agronholm/apscheduler
3 :alt: Build Status
4.. image:: https://coveralls.io/repos/github/agronholm/apscheduler/badge.svg?branch=3.x
5 :target: https://coveralls.io/github/agronholm/apscheduler?branch=3.x
6 :alt: Code Coverage
7
8Advanced Python Scheduler (APScheduler) is a Python library that lets you schedule your Python code
9to be executed later, either just once or periodically. You can add new jobs or remove old ones on
10the fly as you please. If you store your jobs in a database, they will also survive scheduler
11restarts and maintain their state. When the scheduler is restarted, it will then run all the jobs
12it should have run while it was offline [#f1]_.
13
14Among other things, APScheduler can be used as a cross-platform, application specific replacement
15to platform specific schedulers, such as the cron daemon or the Windows task scheduler. Please
16note, however, that APScheduler is **not** a daemon or service itself, nor does it come with any
17command line tools. It is primarily meant to be run inside existing applications. That said,
18APScheduler does provide some building blocks for you to build a scheduler service or to run a
19dedicated scheduler process.
20
21APScheduler has three built-in scheduling systems you can use:
22
23* Cron-style scheduling (with optional start/end times)
24* Interval-based execution (runs jobs on even intervals, with optional start/end times)
25* One-off delayed execution (runs jobs once, on a set date/time)
26
27You can mix and match scheduling systems and the backends where the jobs are stored any way you
28like. Supported backends for storing jobs include:
29
30* Memory
31* `SQLAlchemy <http://www.sqlalchemy.org/>`_ (any RDBMS supported by SQLAlchemy works)
32* `MongoDB <http://www.mongodb.org/>`_
33* `Redis <http://redis.io/>`_
34* `RethinkDB <https://www.rethinkdb.com/>`_
35* `ZooKeeper <https://zookeeper.apache.org/>`_
36
37APScheduler also integrates with several common Python frameworks, like:
38
39* `asyncio <http://docs.python.org/3.4/library/asyncio.html>`_ (:pep:`3156`)
40* `gevent <http://www.gevent.org/>`_
41* `Tornado <http://www.tornadoweb.org/>`_
42* `Twisted <http://twistedmatrix.com/>`_
43* `Qt <http://qt-project.org/>`_ (using either
44 `PyQt <http://www.riverbankcomputing.com/software/pyqt/intro>`_ ,
45 `PySide2 <https://wiki.qt.io/Qt_for_Python>`_ or
46 `PySide <http://qt-project.org/wiki/PySide>`_)
47
48There are third party solutions for integrating APScheduler with other frameworks:
49
50* `Django <https://github.com/jarekwg/django-apscheduler>`_
51* `Flask <https://github.com/viniciuschiele/flask-apscheduler>`_
52
53
54.. [#f1] The cutoff period for this is also configurable.
55
56
57Documentation
58-------------
59
60Documentation can be found `here <https://apscheduler.readthedocs.io/>`_.
61
62
63Source
64------
65
66The source can be browsed at `Github <https://github.com/agronholm/apscheduler/tree/3.x>`_.
67
68
69Reporting bugs
70--------------
71
72A `bug tracker <https://github.com/agronholm/apscheduler/issues>`_ is provided by Github.
73
74
75Getting help
76------------
77
78If you have problems or other questions, you can either:
79
80* Ask in the `apscheduler <https://gitter.im/apscheduler/Lobby>`_ room on Gitter
81* Ask on the `APScheduler Google group <http://groups.google.com/group/apscheduler>`_, or
82* Ask on `StackOverflow <http://stackoverflow.com/questions/tagged/apscheduler>`_ and tag your
83 question with the ``apscheduler`` tag
84
