Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
petrilli committed Jan 16, 2015
1 parent e410790 commit 55ef023
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,21 @@ Transactional Celery for Pyramid
:target: https://pypi.python.org/pypi/pyramid_transactional_celery


A transaction-aware Celery job setup
A transaction-aware Celery job setup. This is integrated with the Zope
transaction_ package, which implements a full two-phase commit protocol.
While it is not designed for anything other than Pyramid, it also does not
use any component of Pyramid. It's simply not tested anywhere else.

* Free software: BSD license
* Documentation: https://pyramid_transactional_celery.readthedocs.org.

.. _transaction: https://pypi.python.org/pypi/transaction

Features
--------

* TODO
* Queues tasks into a thread-local when they are called either using ``delay``
or ``apply_async``.
* If the transaction is aborted, then the tasks will never be called.
* If the transaction is committed, the tasks will go through their normal
``apply_async`` process and be queued for processing.

0 comments on commit 55ef023

Please sign in to comment.