Skip to main content

Hedwig Python Library

Project description

https://travis-ci.org/Automatic/hedwig-python.svg?branch=master https://coveralls.io/repos/github/Automatic/hedwig-python/badge.svg?branch=master https://img.shields.io/pypi/v/authedwig.svg?style=flat-square https://img.shields.io/pypi/pyversions/authedwig.svg?style=flat-square https://img.shields.io/pypi/implementation/authedwig.svg?style=flat-square

Hedwig is a inter-service communication bus that works on AWS SQS/SNS, while keeping things pretty simple and straight forward. It uses json schema draft v4 for schema validation so all incoming and outgoing messages are validated against pre-defined schema.

Hedwig allows separation of concerns between consumers and publishers so your services are loosely coupled, and the contract is enforced by the schema validation. Hedwig may also be used to build asynchronous APIs.

For intra-service messaging, see Taskhawk.

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 authedwig

Next, set up a few configuration settings:

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>

HEDWIG_QUEUE = "DEV-MYAPP"

HEDWIG_CALLBACKS = {
    ("email.send", 1): "send_email",
}

HEDWIG_ROUTING = {
    ("email.send", 1): "send-email-v1",
}

HEDWIG_SCHEMA_FILE = "schema.json"

For Django projects, simple use Django settings to configure Hedwig, for non-Django projects, you must declare an environment variable called SETTINGS_MODULE that points to a module where settings may be found.

Create a JSON-schema and save as schema.json:

{
    "id": "https://hedwig.automatic.com/schema#",
    "$schema": "http://json-schema.org/draft-04/schema",
    "schemas": {
        "email.send": {
            "1.*": {
                "description": "Request to send email",
                "type": "object",
                "required": [
                    "to",
                    "subject"
                ],
                "properties": {
                    "to": {
                        "type": "string",
                        "pattern": "^\\S+@\\S+$"
                    },
                    "subject": {
                        "type": "string",
                        "minLength": 2
                    }
                }
            }
        }
    }
}

Then, simply define your topic handler:

@hedwig.task
def send_email(message: hedwig.Message = None) -> None:
    # send email

And finally, send a message:

message = hedwig.Message.new(
    hedwig.MessageType.send_email,
    StrictVersion('1.0'),
    {
        'to': 'example@email.com',
        'subject': 'Hello!',
    },
)
message.publish()

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 authedwig defined above:

$ git clone https://github.com/Automatic/hedwig-python.git
$ cd hedwig-python
$ pyenv virtualenv 3.6.5 hedwig-3.6
...
$ pyenv activate hedwig-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.

Filename, size & hash SHA256 hash help File type Python version Upload date
authedwig-2.0.0-py3-none-any.whl (18.3 kB) Copy SHA256 hash SHA256 Wheel py3 Jul 30, 2018
authedwig-2.0.0.tar.gz (25.8 kB) Copy SHA256 hash SHA256 Source None Jul 30, 2018

Supported by

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