summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Grönholm <alex.gronholm@nextday.fi>2017-10-21 16:13:09 +0300
committerAlex Grönholm <alex.gronholm@nextday.fi>2017-10-21 16:13:09 +0300
commita3ec9f719125a8a8c6ee6da409fd3cb876153d90 (patch)
treec1a2d9b22b51002e2ac9e28ae243e59eeedbf904
parent1b641942a33d027dae793b8958af28831063e409 (diff)
downloadapscheduler-a3ec9f719125a8a8c6ee6da409fd3cb876153d90.tar.gz
Mentioned the Gitter room in README
-rw-r--r--README.rst34
1 files changed, 19 insertions, 15 deletions
diff --git a/README.rst b/README.rst
index f1921e7..8d92ad2 100644
--- a/README.rst
+++ b/README.rst
@@ -5,15 +5,17 @@
:target: https://coveralls.io/github/agronholm/apscheduler?branch=master
:alt: Code Coverage
-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
+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:
@@ -22,8 +24,8 @@ APScheduler has three built-in scheduling systems you can use:
* 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:
+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)
@@ -38,8 +40,9 @@ APScheduler also integrates with several common Python frameworks, like:
* `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>`_
- or `PySide <http://qt-project.org/wiki/PySide>`_)
+* `Qt <http://qt-project.org/>`_ (using either
+ `PyQt <http://www.riverbankcomputing.com/software/pyqt/intro>`_ or
+ `PySide <http://qt-project.org/wiki/PySide>`_)
.. [#f1] The cutoff period for this is also configurable.
@@ -67,7 +70,8 @@ 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`` channel on `Freenode IRC <http://freenode.net/irc_servers.shtml>`_
* Ask on the `APScheduler Google group <http://groups.google.com/group/apscheduler>`_, or
-* Ask on `StackOverflow <http://stackoverflow.com/questions/tagged/apscheduler>`_ and tag your question with the
- ``apscheduler`` tag
+* Ask on `StackOverflow <http://stackoverflow.com/questions/tagged/apscheduler>`_ and tag your
+ question with the ``apscheduler`` tag