summaryrefslogtreecommitdiff
path: root/docs/modules/schedulers/background.rst
blob: b12cd205724376af98618a4c5ce4e6b578aafeff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
:mod:`apscheduler.schedulers.background`
========================================

.. automodule:: apscheduler.schedulers.background

API
---

.. autoclass:: BackgroundScheduler
    :show-inheritance:


Introduction
------------

BackgroundScheduler runs in a thread **inside** your existing application. Calling
:meth:`~apscheduler.schedulers.blocking.BackgroundScheduler.start` will start the scheduler and it will continue running
after the call returns.

.. list-table::
   :widths: 1 4

   * - Default executor
     - :class:`~apscheduler.executors.pool.PoolExecutor`
   * - External dependencies
     - none
   * - Example
     - ``examples/schedulers/background.py``
       (`view online <https://github.com/agronholm/apscheduler/tree/master/examples/schedulers/background.py>`_).