Metadata-Version: 1.1
Name: qoo
Version: 0.0.4
Summary: A simple library for interacting with Amazon SQS.
Home-page: https://github.com/jpetrucciani/qoo.git
Author: Jacobi Petrucciani
Author-email: jacobi@mimirhq.com
License: MIT
Download-URL: https://github.com/jpetrucciani/qoo.git
Description: qoo: a simple SQS client
        ========================
        
        .. image:: https://travis-ci.org/jpetrucciani/qoo.svg?branch=master
            :target: https://travis-ci.org/jpetrucciani/qoo
        
        
        .. image:: https://badge.fury.io/py/qoo.svg
           :target: https://badge.fury.io/py/qoo
           :alt: PyPI version
        
        
        .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
           :target: https://github.com/ambv/black
           :alt: Code style: black
        
        
        .. image:: https://img.shields.io/badge/python-3.5+-blue.svg
           :target: https://www.python.org/downloads/release/python-350/
           :alt: Python 3.5+ supported
        
        
        **qoo** is a very simple Amazon SQS client, written in Python. It
        aims to be much more straight-forward to use than boto3, and specializes
        only in Amazon SQS, ignoring the rest of the AWS ecosystem.
        
        
        Features
        --------
        
        - Easier interaction with SQS queues
        - Automatic support for ``AWS_ACCESS_KEY_ID``, ``AWS_SECRET_ACCESS_KEY``, and ``AWS_DEFAULT_REGION`` environment variables.
        - automatic useful message/job metadata
        
        Usage
        -----
        
        Installation
        ^^^^^^^^^^^^
        
        .. code-block:: bash
        
           pip install qoo
        
        Basic Usage
        ^^^^^^^^^^^
        
        .. code-block:: python
        
           import qoo
        
           # list SQS queue names
           qoo.list_queues()
        
           # get an existing queue
           queue = qoo.get("$QUEUE_NAME")
        
           # or create a queue
           queue = qoo.create("$QUEUE_NAME")
        
           # send a job, pass info/keys as kwargs
           queue.send(info="foo", user_id="test_user")  # etc.
        
           # get an approximate count of messages in the queue
           len(queue)                # approximate total messages
           queue.approx_not_visible  # approximate number of message in the visibility timeout
        
           # get a job
           job = queue.receive(wait_time=1)
           job.elapsed      # time between sending the job and receiving it
           job.md5_matches  # boolean property to show that the md5 of the job matches what was sent
        
           # and the data from the job is automatically converted into attrs
           job.info         # the string "foo"
           job.user_id      # the string "test_user"
        
           # delete the job from the SQS queue
           job.delete()
        
        
        Testing
        -------
        
        Tests can be run with tox!
        
        .. code-block:: bash
        
           # run tests
           tox
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
