Metadata-Version: 2.1
Name: sqjobs-tf
Version: 0.8.9
Summary: Simple Queue Jobs TF Fork
Home-page: http://github.com/Thinkful/sqjobs
Author: Thinkful
Author-email: engineering@thinkful.com
License: BSD
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: System :: Systems Administration
Requires-Dist: boto3
Requires-Dist: botocore
Requires-Dist: croniter
Requires-Dist: docopt
Requires-Dist: docutils
Requires-Dist: jmespath (>=0.9.0)
Requires-Dist: python-dateutil
Requires-Dist: pytz
Requires-Dist: six

sqjobs
======

|Build Status| |Coverage Status|

Origin
------

This is a fork of the original [sqjobs](https://github.com/igalarzab/sqjobs/)


Installation
------------

Simply use pip to install the last version of ``sqjobs``

::

    pip install --upgrade sqjobs


Getting started
---------------

First you have to create jobs. A job is simply a class that inherits
from ``Job``.

.. code:: python

    from sqjobs import Job

    class Adder(Job):
        default_queue_name = 'queue_name'

        def run(self, num1, num2):
            return num1 + num2

Then, you can launch the job creating a new broker.

.. code:: python

    from sqjobs import create_sqs_broker

    broker = create_sqs_broker(access_key='ak', secret_key='sk')
    broker.add_job(AdderJob, 1, 2, queue_name='other_queue_name')


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

Check out `sqjobs's documentation` for further information.

.. _sqjobs's documentation: https://sqjobs.readthedocs.org

.. |Build Status| image:: https://travis-ci.org/igalarzab/sqjobs.svg?branch=master
   :target: https://secure.travis-ci.org/igalarzab/sqjobs
.. |Coverage Status| image:: https://coveralls.io/repos/igalarzab/sqjobs/badge.png?branch=master
   :target: https://coveralls.io/r/igalarzab/sqjobs?branch=master


