Skip to main content

Taskhawk Python Library

Project description

https://travis-ci.org/cloudchacho/taskhawk-python.svg?branch=master https://coveralls.io/repos/github/cloudchacho/taskhawk-python/badge.svg?branch=master https://img.shields.io/pypi/v/taskhawk.svg?style=flat-square https://img.shields.io/pypi/pyversions/taskhawk.svg?style=flat-square https://img.shields.io/pypi/implementation/taskhawk.svg?style=flat-square https://img.shields.io/badge/code%20style-black-000000.svg

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('example@email.com', 'Hello!', from_email='example@spammer.com')

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

Project details


Download files

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

Source Distribution

taskhawk-4.7.0.tar.gz (39.4 kB view details)

Uploaded Source

Built Distribution

taskhawk-4.7.0-py3-none-any.whl (30.5 kB view details)

Uploaded Python 3

File details

Details for the file taskhawk-4.7.0.tar.gz.

File metadata

  • Download URL: taskhawk-4.7.0.tar.gz
  • Upload date:
  • Size: 39.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.14

File hashes

Hashes for taskhawk-4.7.0.tar.gz
Algorithm Hash digest
SHA256 54923eff9b4702fee6ed00dc5a63aade34699a44cd9b1e4c20179c92b686187d
MD5 7bbb17e5b3c9cbc16856bff060eb3336
BLAKE2b-256 2a017ff1b2aecb76b51d3c42baa619cfe195bc056c94d1b66be7e8c9f553088b

See more details on using hashes here.

File details

Details for the file taskhawk-4.7.0-py3-none-any.whl.

File metadata

  • Download URL: taskhawk-4.7.0-py3-none-any.whl
  • Upload date:
  • Size: 30.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.14

File hashes

Hashes for taskhawk-4.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7ce2180ff8eaedbf3c2da78f4ce64de7c3abc9a0c70da666b6a50851a22a0203
MD5 bdb0cc3c4978104c7d523d5b6c3a4f69
BLAKE2b-256 6c107430897f77a02ade9057fa3b3d502ba0aaa84065335975d3b2851c8890e7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page