summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authoragronholm <devnull@localhost>2011-01-23 00:13:45 +0200
committeragronholm <devnull@localhost>2011-01-23 00:13:45 +0200
commitcdb7c21b44ae97ef069579fdd574176800d17fcb (patch)
treef8a790c2d61d669016e72b226ce5db0022edaa0a /README.rst
parentc45a1d31f0e8c6be994aa046a21ab818aacd9302 (diff)
downloadapscheduler-cdb7c21b44ae97ef069579fdd574176800d17fcb.tar.gz
Renamed CHANGES.txt and README.txt to CHANGES.rst and README.rst respectively to correctly identify them as ReST documents
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..1f6e990
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,36 @@
+Advanced Python Scheduler (APScheduler) is a light but powerful in-process task
+scheduler that lets you schedule jobs (functions or any python callables) to be
+executed at times of your choosing.
+
+The development of APScheduler was heavily influenced by the `Quartz
+<http://www.opensymphony.com/quartz/>`_ task scheduler written in Java, and
+it provides most of the major features that Quartz does.
+
+
+Features
+========
+
+* No external dependencies
+* Thread-safe API
+* Configurable scheduling mechanisms (triggers):
+ * Cron-like scheduling
+ * Delayed scheduling of single fire jobs (like the UNIX "at" command)
+ * Interval-based scheduling of jobs, with configurable start date and
+ repeat count
+* Configurable job stores:
+ * RAM
+ * File-based simple database (shelve)
+ * `SQLAlchemy <http://www.sqlalchemy.org/>`_ (any supported RDBMS works)
+
+
+Documentation
+=============
+
+Documentation can be found `here <http://packages.python.org/APScheduler/>`_.
+
+
+Source
+======
+
+The source can be browsed at `Bitbucket
+<http://bitbucket.org/agronholm/apscheduler/src/>`_.