taskhawk 4.1.2

Taskhawk Python Library

TaskHawk is a replacement for celery that works on AWS SQS/SNS and Google PubSub, while keeping things pretty simple and straightforward. Any unbound function can be converted into a TaskHawk task.

Only Python 3.6+ is supported currently.

You can find the latest, most up to date, documentation at Read the Docs.

Quick Start

First, install the library:

$ pip install taskhawk

Next, set up a few configuration settings:

Common required settings:

TASKHAWK_QUEUE = "DEV-MYAPP"

When using AWS, additional required settings are:

AWS_ACCESS_KEY = <YOUR AWS KEY>
AWS_ACCOUNT_ID = <YOUR AWS ACCOUNT ID>
AWS_REGION = <YOUR AWS REGION>
AWS_SECRET_KEY = <YOUR AWS SECRET KEY>

TASKHAWK_CONSUMER_BACKEND = 'taskhawk.backends.aws.AWSSQSConsumerBackend'
TASKHAWK_PUBLISHER_BACKEND = 'taskhawk.backends.aws.AWSSNSPublisherBackend'

In case of GCP, additional required settings are:

TASKHAWK_CONSUMER_BACKEND = 'taskhawk.backends.gcp.GooglePubSubConsumerBackend'
TASKHAWK_PUBLISHER_BACKEND = 'taskhawk.backends.gcp.GooglePubSubPublisherBackend'

If running outside Google Cloud (e.g. locally), set GOOGLE_APPLICATION_CREDENTIALS.

Within Google Cloud, these credentials and permissions are managed by Google using IAM.

If the Pub/Sub resources lie in a different project, set GOOGLE_CLOUD_PROJECT to the project id.

For Django projects, simple use Django settings to configure Taskhawk. For Flask projects, use Flask config. For other frameworks, you can either declare an environment variable called SETTINGS_MODULE that points to a module where settings may be found, or manually configure using taskhawk.conf.settings.configure_with_object.

Then, simply add the decorator taskhawk.task to your function:

@taskhawk.task
def send_email(to: str, subject: str, from_email: str = None) -> None:
    # send email

And finally, dispatch your function asynchronously:

send_email.dispatch('[e-mail]', 'Hello!', from_email='[e-mail]')

Development

Getting Started

Assuming that you have Python, pyenv and pyenv-virtualenv installed, set up your environment and install the required dependencies like this instead of the pip install taskhawk defined above:

$ git clone https://github.com/cloudchacho/taskhawk-python.git
$ cd taskhawk-python
$ pyenv virtualenv 3.7.7 taskhawk-python-3.7
...
$ pyenv activate taskhawk-python-3.7
$ pip install -r requirements/dev-3.7.txt

Running Tests

You can run tests in using make test. By default, it will run all of the unit and functional tests, but you can also specify your own py.test options.

$ py.test
$ py.test tests/test_consumer.py

Generating Documentation

Sphinx is used for documentation. You can generate HTML locally with the following:

$ pip install -e .[dev]
$ make docs

Getting Help

We use GitHub issues for tracking bugs and feature requests.

• If it turns out that you may have found a bug, please open an issue