Skip to main content

A simple Amazon SQS consumer library.

Project description

Squishy

https://circleci.com/gh/tmehlinger/squishy/tree/master.svg?style=shield https://coveralls.io/repos/github/tmehlinger/squishy/badge.svg?branch=master

Squishy is a simple Amazon SQS consumer for Python. Many versions of Python are supported, including 2.7, 3.3, 3.4, and 3.5. 2.6 should work but it is untested and unsupported.

This is currently beta software! It has a suite of tests and it’s being used for non-critical production tasks but it is still very young software.

Installing

Install from pypi: pip install squishy

Developing

  • Create a virtualenv.
  • Clone the repo.
  • Install the requirements. If you want to use the futures workers on Python 2.7, be sure to install futures.
  • Run python setup.py develop to get the squishy CLI tool.

Using

Squishy provides a CLI to run a worker that will dispatch messages to a callback you define. The callback should accept a single parameter representing a single message consumed from an SQS queue. The message will be an instance of SQS.Message.

Example:

# my_consumer.py

def my_callback(message):
    print('Got a message! Contents:', message.body)

Then on the command line:

$ squishy run_consumer https://sqs.us-east-1.amazonaws.com/12345/my_queue my_consumer:my_callback

Authentication

Squishy uses boto3, which will automatically load credentials from $HOME/.aws/credentials. If you need more control over authentication, you can give Squishy a factory function for creating a custom session.

CLI reference

$ squishy --help
Usage: squishy [OPTIONS] COMMAND [ARGS]...

Options:
  --log-level [debug|info|warning|error|critical]
                                  Logging level.
  --botocore-log-level [debug|info|warning|error|critical]
                                  botocore logging level.
  --version                       Show the version and exit.
  --help                          Show this message and exit.

Commands:
  run_consumer


$ squishy run_consumer --help
Usage: squishy run_consumer [OPTIONS] QUEUE_URL CALLBACK

Options:
  --session-factory TEXT          Factory function for a custom boto3.Session.
  -c, --concurrency INTEGER       Worker concurrency.
  -m, --polling-method [long|short]
                                  Polling method.
  -t, --polling-timeout INTEGER   Polling interval in seconds.
  -n, --polling-count INTEGER     Number of messages to fetch when polling.
  -w, --worker-class [futures_process|futures_thread|gevent|mp_process|mp_thread]
                                  Worker class.
  --help                          Show this message and exit.

Changelog

0.1.1

Bug fixes

  • The string used to import a callback now much have a colon in it, matching the behavior of setuptools. This was implied before but not required.
  • The gevent worker no longer fails with an AttributeError when processing messages.

New features

  • Vastly improved test coverage.

0.1.0

BREAKING CHANGES

  • The consumer now dispatches an SQS.Message instance to the callback instead of dictionary.

Bug fixes

  • Fixed a bug in the multiprocessing workers where they would iterate infinitely if the callback raised an exception.

New features

  • Squishy now has unit tests!

0.0.3

Bug fixes

  • Fixed relative imports for modules that have the same name as a package. (Alejandro Mesa)
  • Fixed missing import for gevent.monkey. (Alejandro Mesa)
  • Fixed a bug with passing the message to the worker process without unpacking the dictionary. (Alejandro Mesa)
  • Fixed a bug where the worker would fail to handle keyboard interrupts. (Alejandro Mesa)
  • Fixed a bug with deleting keys from the results_to_message list while iterating through the list. (Alejandro Mesa)

0.0.2

Bug fixes

  • Switched to RST to be PyPI-friendly.

0.0.1

  • First release.

Project details


Release history Release notifications

This version
History Node

0.1.1

History Node

0.1.0

History Node

0.0.3

History Node

0.0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
squishy-0.1.1-py3-none-any.whl (14.7 kB) Copy SHA256 hash SHA256 Wheel py3 Sep 24, 2016
squishy-0.1.1.tar.gz (10.5 kB) Copy SHA256 hash SHA256 Source None Sep 24, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page