METADATA 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. Metadata-Version: 2.1
  2. Name: APScheduler
  3. Version: 3.11.0
  4. Summary: In-process task scheduler with Cron-like capabilities
  5. Author-email: Alex Grönholm <alex.gronholm@nextday.fi>
  6. License: MIT
  7. Project-URL: Documentation, https://apscheduler.readthedocs.io/en/3.x/
  8. Project-URL: Changelog, https://apscheduler.readthedocs.io/en/3.x/versionhistory.html
  9. Project-URL: Source code, https://github.com/agronholm/apscheduler
  10. Project-URL: Issue tracker, https://github.com/agronholm/apscheduler/issues
  11. Keywords: scheduling,cron
  12. Classifier: Development Status :: 5 - Production/Stable
  13. Classifier: Intended Audience :: Developers
  14. Classifier: License :: OSI Approved :: MIT License
  15. Classifier: Programming Language :: Python
  16. Classifier: Programming Language :: Python :: 3 :: Only
  17. Classifier: Programming Language :: Python :: 3.8
  18. Classifier: Programming Language :: Python :: 3.9
  19. Classifier: Programming Language :: Python :: 3.10
  20. Classifier: Programming Language :: Python :: 3.11
  21. Classifier: Programming Language :: Python :: 3.12
  22. Classifier: Programming Language :: Python :: 3.13
  23. Requires-Python: >=3.8
  24. Description-Content-Type: text/x-rst
  25. License-File: LICENSE.txt
  26. Requires-Dist: tzlocal>=3.0
  27. Requires-Dist: backports.zoneinfo; python_version < "3.9"
  28. Provides-Extra: etcd
  29. Requires-Dist: etcd3; extra == "etcd"
  30. Requires-Dist: protobuf<=3.21.0; extra == "etcd"
  31. Provides-Extra: gevent
  32. Requires-Dist: gevent; extra == "gevent"
  33. Provides-Extra: mongodb
  34. Requires-Dist: pymongo>=3.0; extra == "mongodb"
  35. Provides-Extra: redis
  36. Requires-Dist: redis>=3.0; extra == "redis"
  37. Provides-Extra: rethinkdb
  38. Requires-Dist: rethinkdb>=2.4.0; extra == "rethinkdb"
  39. Provides-Extra: sqlalchemy
  40. Requires-Dist: sqlalchemy>=1.4; extra == "sqlalchemy"
  41. Provides-Extra: tornado
  42. Requires-Dist: tornado>=4.3; extra == "tornado"
  43. Provides-Extra: twisted
  44. Requires-Dist: twisted; extra == "twisted"
  45. Provides-Extra: zookeeper
  46. Requires-Dist: kazoo; extra == "zookeeper"
  47. Provides-Extra: test
  48. Requires-Dist: APScheduler[etcd,mongodb,redis,rethinkdb,sqlalchemy,tornado,zookeeper]; extra == "test"
  49. Requires-Dist: pytest; extra == "test"
  50. Requires-Dist: anyio>=4.5.2; extra == "test"
  51. Requires-Dist: PySide6; (platform_python_implementation == "CPython" and python_version < "3.14") and extra == "test"
  52. Requires-Dist: gevent; python_version < "3.14" and extra == "test"
  53. Requires-Dist: pytz; extra == "test"
  54. Requires-Dist: twisted; python_version < "3.14" and extra == "test"
  55. Provides-Extra: doc
  56. Requires-Dist: packaging; extra == "doc"
  57. Requires-Dist: sphinx; extra == "doc"
  58. Requires-Dist: sphinx-rtd-theme>=1.3.0; extra == "doc"
  59. .. image:: https://github.com/agronholm/apscheduler/workflows/Python%20codeqa/test/badge.svg?branch=3.x
  60. :target: https://github.com/agronholm/apscheduler/actions?query=workflow%3A%22Python+codeqa%2Ftest%22+branch%3A3.x
  61. :alt: Build Status
  62. .. image:: https://coveralls.io/repos/github/agronholm/apscheduler/badge.svg?branch=3.x
  63. :target: https://coveralls.io/github/agronholm/apscheduler?branch=3.x
  64. :alt: Code Coverage
  65. .. image:: https://readthedocs.org/projects/apscheduler/badge/?version=3.x
  66. :target: https://apscheduler.readthedocs.io/en/master/?badge=3.x
  67. :alt: Documentation
  68. Advanced Python Scheduler (APScheduler) is a Python library that lets you schedule your Python code
  69. to be executed later, either just once or periodically. You can add new jobs or remove old ones on
  70. the fly as you please. If you store your jobs in a database, they will also survive scheduler
  71. restarts and maintain their state. When the scheduler is restarted, it will then run all the jobs
  72. it should have run while it was offline [#f1]_.
  73. Among other things, APScheduler can be used as a cross-platform, application specific replacement
  74. to platform specific schedulers, such as the cron daemon or the Windows task scheduler. Please
  75. note, however, that APScheduler is **not** a daemon or service itself, nor does it come with any
  76. command line tools. It is primarily meant to be run inside existing applications. That said,
  77. APScheduler does provide some building blocks for you to build a scheduler service or to run a
  78. dedicated scheduler process.
  79. APScheduler has three built-in scheduling systems you can use:
  80. * Cron-style scheduling (with optional start/end times)
  81. * Interval-based execution (runs jobs on even intervals, with optional start/end times)
  82. * One-off delayed execution (runs jobs once, on a set date/time)
  83. You can mix and match scheduling systems and the backends where the jobs are stored any way you
  84. like. Supported backends for storing jobs include:
  85. * Memory
  86. * `SQLAlchemy <http://www.sqlalchemy.org/>`_ (any RDBMS supported by SQLAlchemy works)
  87. * `MongoDB <http://www.mongodb.org/>`_
  88. * `Redis <http://redis.io/>`_
  89. * `RethinkDB <https://www.rethinkdb.com/>`_
  90. * `ZooKeeper <https://zookeeper.apache.org/>`_
  91. * `Etcd <https://etcd.io/>`_
  92. APScheduler also integrates with several common Python frameworks, like:
  93. * `asyncio <http://docs.python.org/3.4/library/asyncio.html>`_ (:pep:`3156`)
  94. * `gevent <http://www.gevent.org/>`_
  95. * `Tornado <http://www.tornadoweb.org/>`_
  96. * `Twisted <http://twistedmatrix.com/>`_
  97. * `Qt <http://qt-project.org/>`_ (using either
  98. `PyQt <http://www.riverbankcomputing.com/software/pyqt/intro>`_ ,
  99. `PySide6 <https://wiki.qt.io/Qt_for_Python>`_ ,
  100. `PySide2 <https://wiki.qt.io/Qt_for_Python>`_ or
  101. `PySide <http://qt-project.org/wiki/PySide>`_)
  102. There are third party solutions for integrating APScheduler with other frameworks:
  103. * `Django <https://github.com/jarekwg/django-apscheduler>`_
  104. * `Flask <https://github.com/viniciuschiele/flask-apscheduler>`_
  105. .. [#f1] The cutoff period for this is also configurable.
  106. Documentation
  107. -------------
  108. Documentation can be found `here <https://apscheduler.readthedocs.io/>`_.
  109. Source
  110. ------
  111. The source can be browsed at `Github <https://github.com/agronholm/apscheduler/tree/3.x>`_.
  112. Reporting bugs
  113. --------------
  114. A `bug tracker <https://github.com/agronholm/apscheduler/issues>`_ is provided by Github.
  115. Getting help
  116. ------------
  117. If you have problems or other questions, you can either:
  118. * Ask in the `apscheduler <https://gitter.im/apscheduler/Lobby>`_ room on Gitter
  119. * Ask on the `APScheduler GitHub discussion forum <https://github.com/agronholm/apscheduler/discussions>`_, or
  120. * Ask on `StackOverflow <http://stackoverflow.com/questions/tagged/apscheduler>`_ and tag your
  121. question with the ``apscheduler`` tag