APScheduler


NameAPScheduler JSON
Version 3.10.4 PyPI version JSON
download
home_pagehttps://github.com/agronholm/apscheduler
SummaryIn-process task scheduler with Cron-like capabilities
upload_time2023-08-19 16:44:58
maintainer
docs_urlhttps://pythonhosted.org/APScheduler/
authorAlex Grönholm
requires_python>=3.6
licenseMIT
keywords scheduling cron
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://github.com/agronholm/apscheduler/workflows/Python%20codeqa/test/badge.svg?branch=3.x
  :target: https://github.com/agronholm/apscheduler/actions?query=workflow%3A%22Python+codeqa%2Ftest%22+branch%3A3.x
  :alt: Build Status
.. image:: https://coveralls.io/repos/github/agronholm/apscheduler/badge.svg?branch=3.x
  :target: https://coveralls.io/github/agronholm/apscheduler?branch=3.x
  :alt: Code Coverage
.. image:: https://readthedocs.org/projects/apscheduler/badge/?version=3.x
  :target: https://apscheduler.readthedocs.io/en/master/?badge=3.x
  :alt: Documentation

Advanced Python Scheduler (APScheduler) is a Python library that lets you schedule your Python code
to be executed later, either just once or periodically. You can add new jobs or remove old ones on
the fly as you please. If you store your jobs in a database, they will also survive scheduler
restarts and maintain their state. When the scheduler is restarted, it will then run all the jobs
it should have run while it was offline [#f1]_.

Among other things, APScheduler can be used as a cross-platform, application specific replacement
to platform specific schedulers, such as the cron daemon or the Windows task scheduler. Please
note, however, that APScheduler is **not** a daemon or service itself, nor does it come with any
command line tools. It is primarily meant to be run inside existing applications. That said,
APScheduler does provide some building blocks for you to build a scheduler service or to run a
dedicated scheduler process.

APScheduler has three built-in scheduling systems you can use:

* Cron-style scheduling (with optional start/end times)
* Interval-based execution (runs jobs on even intervals, with optional start/end times)
* One-off delayed execution (runs jobs once, on a set date/time)

You can mix and match scheduling systems and the backends where the jobs are stored any way you
like. Supported backends for storing jobs include:

* Memory
* `SQLAlchemy <http://www.sqlalchemy.org/>`_ (any RDBMS supported by SQLAlchemy works)
* `MongoDB <http://www.mongodb.org/>`_
* `Redis <http://redis.io/>`_
* `RethinkDB <https://www.rethinkdb.com/>`_
* `ZooKeeper <https://zookeeper.apache.org/>`_

APScheduler also integrates with several common Python frameworks, like:

* `asyncio <http://docs.python.org/3.4/library/asyncio.html>`_ (:pep:`3156`)
* `gevent <http://www.gevent.org/>`_
* `Tornado <http://www.tornadoweb.org/>`_
* `Twisted <http://twistedmatrix.com/>`_
* `Qt <http://qt-project.org/>`_ (using either
  `PyQt <http://www.riverbankcomputing.com/software/pyqt/intro>`_ ,
  `PySide6 <https://wiki.qt.io/Qt_for_Python>`_ ,
  `PySide2 <https://wiki.qt.io/Qt_for_Python>`_ or
  `PySide <http://qt-project.org/wiki/PySide>`_)

There are third party solutions for integrating APScheduler with other frameworks:

* `Django <https://github.com/jarekwg/django-apscheduler>`_
* `Flask <https://github.com/viniciuschiele/flask-apscheduler>`_


.. [#f1] The cutoff period for this is also configurable.


Documentation
-------------

Documentation can be found `here <https://apscheduler.readthedocs.io/>`_.


Source
------

The source can be browsed at `Github <https://github.com/agronholm/apscheduler/tree/3.x>`_.


Reporting bugs
--------------

A `bug tracker <https://github.com/agronholm/apscheduler/issues>`_ is provided by Github.


Getting help
------------

If you have problems or other questions, you can either:

* Ask in the `apscheduler <https://gitter.im/apscheduler/Lobby>`_ room on Gitter
* Ask on the `APScheduler GitHub discussion forum <https://github.com/agronholm/apscheduler/discussions>`_, or
* Ask on `StackOverflow <http://stackoverflow.com/questions/tagged/apscheduler>`_ and tag your
  question with the ``apscheduler`` tag

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/agronholm/apscheduler",
    "name": "APScheduler",
    "maintainer": "",
    "docs_url": "https://pythonhosted.org/APScheduler/",
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "scheduling cron",
    "author": "Alex Gr\u00f6nholm",
    "author_email": "apscheduler@nextday.fi",
    "download_url": "https://files.pythonhosted.org/packages/5e/34/5dcb368cf89f93132d9a31bd3747962a9dc874480e54333b0c09fa7d56ac/APScheduler-3.10.4.tar.gz",
    "platform": null,
    "description": ".. image:: https://github.com/agronholm/apscheduler/workflows/Python%20codeqa/test/badge.svg?branch=3.x\n  :target: https://github.com/agronholm/apscheduler/actions?query=workflow%3A%22Python+codeqa%2Ftest%22+branch%3A3.x\n  :alt: Build Status\n.. image:: https://coveralls.io/repos/github/agronholm/apscheduler/badge.svg?branch=3.x\n  :target: https://coveralls.io/github/agronholm/apscheduler?branch=3.x\n  :alt: Code Coverage\n.. image:: https://readthedocs.org/projects/apscheduler/badge/?version=3.x\n  :target: https://apscheduler.readthedocs.io/en/master/?badge=3.x\n  :alt: Documentation\n\nAdvanced Python Scheduler (APScheduler) is a Python library that lets you schedule your Python code\nto be executed later, either just once or periodically. You can add new jobs or remove old ones on\nthe fly as you please. If you store your jobs in a database, they will also survive scheduler\nrestarts and maintain their state. When the scheduler is restarted, it will then run all the jobs\nit should have run while it was offline [#f1]_.\n\nAmong other things, APScheduler can be used as a cross-platform, application specific replacement\nto platform specific schedulers, such as the cron daemon or the Windows task scheduler. Please\nnote, however, that APScheduler is **not** a daemon or service itself, nor does it come with any\ncommand line tools. It is primarily meant to be run inside existing applications. That said,\nAPScheduler does provide some building blocks for you to build a scheduler service or to run a\ndedicated scheduler process.\n\nAPScheduler has three built-in scheduling systems you can use:\n\n* Cron-style scheduling (with optional start/end times)\n* Interval-based execution (runs jobs on even intervals, with optional start/end times)\n* One-off delayed execution (runs jobs once, on a set date/time)\n\nYou can mix and match scheduling systems and the backends where the jobs are stored any way you\nlike. Supported backends for storing jobs include:\n\n* Memory\n* `SQLAlchemy <http://www.sqlalchemy.org/>`_ (any RDBMS supported by SQLAlchemy works)\n* `MongoDB <http://www.mongodb.org/>`_\n* `Redis <http://redis.io/>`_\n* `RethinkDB <https://www.rethinkdb.com/>`_\n* `ZooKeeper <https://zookeeper.apache.org/>`_\n\nAPScheduler also integrates with several common Python frameworks, like:\n\n* `asyncio <http://docs.python.org/3.4/library/asyncio.html>`_ (:pep:`3156`)\n* `gevent <http://www.gevent.org/>`_\n* `Tornado <http://www.tornadoweb.org/>`_\n* `Twisted <http://twistedmatrix.com/>`_\n* `Qt <http://qt-project.org/>`_ (using either\n  `PyQt <http://www.riverbankcomputing.com/software/pyqt/intro>`_ ,\n  `PySide6 <https://wiki.qt.io/Qt_for_Python>`_ ,\n  `PySide2 <https://wiki.qt.io/Qt_for_Python>`_ or\n  `PySide <http://qt-project.org/wiki/PySide>`_)\n\nThere are third party solutions for integrating APScheduler with other frameworks:\n\n* `Django <https://github.com/jarekwg/django-apscheduler>`_\n* `Flask <https://github.com/viniciuschiele/flask-apscheduler>`_\n\n\n.. [#f1] The cutoff period for this is also configurable.\n\n\nDocumentation\n-------------\n\nDocumentation can be found `here <https://apscheduler.readthedocs.io/>`_.\n\n\nSource\n------\n\nThe source can be browsed at `Github <https://github.com/agronholm/apscheduler/tree/3.x>`_.\n\n\nReporting bugs\n--------------\n\nA `bug tracker <https://github.com/agronholm/apscheduler/issues>`_ is provided by Github.\n\n\nGetting help\n------------\n\nIf you have problems or other questions, you can either:\n\n* Ask in the `apscheduler <https://gitter.im/apscheduler/Lobby>`_ room on Gitter\n* Ask on the `APScheduler GitHub discussion forum <https://github.com/agronholm/apscheduler/discussions>`_, or\n* Ask on `StackOverflow <http://stackoverflow.com/questions/tagged/apscheduler>`_ and tag your\n  question with the ``apscheduler`` tag\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "In-process task scheduler with Cron-like capabilities",
    "version": "3.10.4",
    "project_urls": {
        "Homepage": "https://github.com/agronholm/apscheduler"
    },
    "split_keywords": [
        "scheduling",
        "cron"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "13b57af0cb920a476dccd612fbc9a21a3745fb29b1fcd74636078db8f7ba294c",
                "md5": "8b19ac3e52c9d7a80b512c68645ebaea",
                "sha256": "fb91e8a768632a4756a585f79ec834e0e27aad5860bac7eaa523d9ccefd87661"
            },
            "downloads": -1,
            "filename": "APScheduler-3.10.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8b19ac3e52c9d7a80b512c68645ebaea",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 59303,
            "upload_time": "2023-08-19T16:44:56",
            "upload_time_iso_8601": "2023-08-19T16:44:56.814868Z",
            "url": "https://files.pythonhosted.org/packages/13/b5/7af0cb920a476dccd612fbc9a21a3745fb29b1fcd74636078db8f7ba294c/APScheduler-3.10.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5e345dcb368cf89f93132d9a31bd3747962a9dc874480e54333b0c09fa7d56ac",
                "md5": "cf4dd44a52f05e4a06dc104de52e41f5",
                "sha256": "e6df071b27d9be898e486bc7940a7be50b4af2e9da7c08f0744a96d4bd4cef4a"
            },
            "downloads": -1,
            "filename": "APScheduler-3.10.4.tar.gz",
            "has_sig": false,
            "md5_digest": "cf4dd44a52f05e4a06dc104de52e41f5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 100832,
            "upload_time": "2023-08-19T16:44:58",
            "upload_time_iso_8601": "2023-08-19T16:44:58.293868Z",
            "url": "https://files.pythonhosted.org/packages/5e/34/5dcb368cf89f93132d9a31bd3747962a9dc874480e54333b0c09fa7d56ac/APScheduler-3.10.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-19 16:44:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "agronholm",
    "github_project": "apscheduler",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "apscheduler"
}
        
Elapsed time: 0.24400s