Package: authedwig
Hedwig is a inter-service communication bus that works on AWS SQS/SNS, while keeping things pretty simple and
straight forward. It usesjson schemadraft v4for 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, seeTaskhawk.Only Python 3.6+ is supported currently.You can find the latest, most up to date, documentation atRead the Docs.Quick StartFirst, install the library:$pipinstallauthedwig[aws,jsonschema]Next, set up a few configuration settings:Common required settings:HEDWIG_QUEUE="DEV-MYAPP"HEDWIG_CALLBACKS={("email.send","1.*"):"send_email",}HEDWIG_MESSAGE_ROUTING={("email.send","1.*"):"send-email-v1",}HEDWIG_JSONSCHEMA_FILE="schema.json"When using AWS, additional required settings are:AWS_ACCESS_KEY=<YOURAWSKEY>AWS_ACCOUNT_ID=<YOURAWSACCOUNTID>AWS_REGION=<YOURAWSREGION>AWS_SECRET_KEY=<YOURAWSSECRETKEY>HEDWIG_CONSUMER_BACKEND='hedwig.backends.aws.AWSSQSConsumerBackend'HEDWIG_PUBLISHER_BACKEND='hedwig.backends.aws.AWSSNSPublisherBackend'In case of GCP, additional required settings are:HEDWIG_CONSUMER_BACKEND='hedwig.backends.gcp.GooglePubSubConsumerBackend'HEDWIG_PUBLISHER_BACKEND='hedwig.backends.gcp.GooglePubSubPublisherBackend'HEDWIG_SUBSCRIPTIONS=["dev-user-created-v1"]If running outside Google Cloud (e.g. locally), setGOOGLE_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, setGOOGLE_CLOUD_PROJECTto the project id.For Django projects, simple useDjango settingsto configure Hedwig. For Flask projects, useFlask config.
For other frameworks, you can either declare an environment variable calledSETTINGS_MODULEthat points to a
module where settings may be found, or manually configure usinghedwig.conf.settings.configure_with_object.Create a JSON-schema and save asschema.json:{"id":"https://github.com/cloudchacho/hedwig-python/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:defsend_email(message:hedwig.Message=None)->None:# send emailAnd finally, send a message:message=hedwig.Message.new("email.send",StrictVersion('1.0'),{'to':'example@email.com','subject':'Hello!',},)message.publish()DevelopmentGetting StartedAssuming that you have Python,pyenvandpyenv-virtualenv, andprotoc installed, set up your
environment and install the required dependencies like this instead of
thepip install authedwigdefined above:$gitclonehttps://github.com/cloudchacho/hedwig.git/usr/local/lib/protobuf/include/hedwig...$gitclonehttps://github.com/cloudchacho/hedwig-python.git$cdhedwig-python$pyenvvirtualenv3.6.5hedwig-3.6...$pyenvactivatehedwig-3.6$pipinstall-rrequirements/dev-3.6.txtRe-compile protobufOn making any change to test protobufs or container protobuf, the file would need to be re-compiled:$makeproto_compileRunning TestsYou can run tests in usingmake test. By default,
it will run all of the unit and functional tests, but you can also specify your ownpy.testoptions.$py.test$py.testtests/test_consumer.pyGenerating DocumentationSphinx is used for documentation. You can generate HTML locally with the
following:$pipinstall-e.[dev]$makedocsGetting HelpWe use GitHub issues for tracking bugs and feature requests.If it turns out that you may have found a bug, pleaseopen an issue