Skip to main content

Taskhawk Python Library

Project description

https://travis-ci.org/Automatic/taskhawk-python.svg?branch=master https://coveralls.io/repos/github/Automatic/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/Automatic/taskhawk-python.git
$ cd taskhawk-python
$ pyenv virtualenv 3.6.5 taskhawk-3.6
...
$ pyenv activate taskhawk-3.6
$ pip install -r requirements/dev-3.6.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.0.4.tar.gz (30.6 kB view details)

Uploaded Source

Built Distribution

taskhawk-4.0.4-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: taskhawk-4.0.4.tar.gz
  • Upload date:
  • Size: 30.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for taskhawk-4.0.4.tar.gz
Algorithm Hash digest
SHA256 343df4510b4d6b867fbe4dc80ff6037f85b73ef48e962b355063553d49ef3c54
MD5 6a6b4e71510cb63eece236cb706a2cb5
BLAKE2b-256 b9cbfe3fd8779ae294279f6dc9e340151a4a954f9c4e731b215086123da0d67f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: taskhawk-4.0.4-py3-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.10

File hashes

Hashes for taskhawk-4.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 185ec81ca5e94adeff4f5dd7fcada0f10e7e8b25c80d2a8e2f0c6e18951b6f60
MD5 8e3c10aa4a3278f2c9e9ece39d65569a
BLAKE2b-256 7638ff0be3149403f3c47c5960382760e246daea49259520b1c1ab2548e581b2

See more details on using hashes here.

Supported by

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