{"id":43067045,"url":"https://github.com/cloudchacho/hedwig-python","last_synced_at":"2026-01-31T12:52:02.027Z","repository":{"id":45857030,"uuid":"380327326","full_name":"cloudchacho/hedwig-python","owner":"cloudchacho","description":"Messaging bus for micro-services that works on cloud native queues http://authedwig.rtfd.io ","archived":false,"fork":false,"pushed_at":"2025-10-29T17:37:04.000Z","size":506,"stargazers_count":1,"open_issues_count":3,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-29T18:37:52.794Z","etag":null,"topics":["distributed-systems","message-bus","messagebus","messaging","microservices"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudchacho.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-06-25T18:43:17.000Z","updated_at":"2025-10-29T17:36:49.000Z","dependencies_parsed_at":"2025-06-16T19:33:08.148Z","dependency_job_id":"695f85c6-ed52-4c23-877c-6b12f3bd8329","html_url":"https://github.com/cloudchacho/hedwig-python","commit_stats":{"total_commits":258,"total_committers":10,"mean_commits":25.8,"dds":0.562015503875969,"last_synced_commit":"f1d6160cfeb20c847ff3a5d52cb68d78c308f388"},"previous_names":[],"tags_count":57,"template":false,"template_full_name":null,"purl":"pkg:github/cloudchacho/hedwig-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudchacho%2Fhedwig-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudchacho%2Fhedwig-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudchacho%2Fhedwig-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudchacho%2Fhedwig-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudchacho","download_url":"https://codeload.github.com/cloudchacho/hedwig-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudchacho%2Fhedwig-python/sbom","scorecard":{"id":292390,"data":{"date":"2025-08-11","repo":{"name":"github.com/cloudchacho/hedwig-python","commit":"446ab8c9333cb5f55158a6b5fae3412238192598"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.8,"checks":[{"name":"Code-Review","score":2,"reason":"Found 8/30 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":9,"reason":"11 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 9","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pip-compile.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/pip-compile.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pip-compile.yml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/pip-compile.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pip-compile.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/pip-compile.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pip-compile.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/pip-compile.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pip-compile.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/pip-compile.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pip-compile.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/pip-compile.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pip-compile.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/pip-compile.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pip-compile.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/pip-compile.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pytest.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/pytest.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pytest.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/pytest.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pytest.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/pytest.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pytest.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/pytest.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-syntax.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/python-syntax.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-syntax.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/python-syntax.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/cloudchacho/hedwig-python/release.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:3","Warn: pipCommand not pinned by hash: Dockerfile:38","Warn: pipCommand not pinned by hash: scripts/distribute.sh:3","Warn: pipCommand not pinned by hash: scripts/make-docs.sh:9","Warn: pipCommand not pinned by hash: scripts/release.sh:19","Warn: pipCommand not pinned by hash: scripts/test-setup.sh:7","Warn: pipCommand not pinned by hash: scripts/test-setup.sh:15","Warn: pipCommand not pinned by hash: scripts/test-setup.sh:16","Warn: pipCommand not pinned by hash: scripts/test-setup.sh:37","Warn: pipCommand not pinned by hash: .github/workflows/python-syntax.yml:34","Info:   0 out of  11 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   5 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   9 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: topLevel 'contents' permission set to 'read': .github/workflows/pip-compile.yml:7","Warn: no topLevel permission defined: .github/workflows/pytest.yml:1","Warn: no topLevel permission defined: .github/workflows/python-syntax.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/pytest.yml:10"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 9 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T18:36:31.540Z","repository_id":45857030,"created_at":"2025-08-17T18:36:31.540Z","updated_at":"2025-08-17T18:36:31.540Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28943640,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T12:10:04.904Z","status":"ssl_error","status_checked_at":"2026-01-31T12:09:58.894Z","response_time":128,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["distributed-systems","message-bus","messagebus","messaging","microservices"],"created_at":"2026-01-31T12:52:01.247Z","updated_at":"2026-01-31T12:52:02.022Z","avatar_url":"https://github.com/cloudchacho.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Hedwig Library for Python\n=========================\n\n.. image:: https://github.com/cloudchacho/hedwig-python/workflows/Pytest/badge.svg\n    :target: https://github.com/cloudchacho/hedwig-python/actions?query=workflow%3APytest\n\n.. image:: https://codecov.io/gh/cloudchacho/hedwig-python/branch/main/graph/badge.svg?token=81LqiGysSn\n    :target: https://codecov.io/gh/cloudchacho/hedwig-python\n\n.. image:: https://img.shields.io/pypi/v/authedwig.svg?style=flat-square\n    :target: https://pypi.python.org/pypi/authedwig\n\n.. image:: https://img.shields.io/pypi/pyversions/authedwig.svg?style=flat-square\n    :target: https://pypi.python.org/pypi/authedwig\n\n.. image:: https://img.shields.io/pypi/implementation/authedwig.svg?style=flat-square\n    :target: https://pypi.python.org/pypi/authedwig\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/ambv/black\n\nHedwig is a inter-service communication bus that works on AWS SQS/SNS, while keeping things pretty simple and\nstraight forward. It uses `json schema`_ `draft v4`_ for schema validation so all incoming\nand outgoing messages are validated against pre-defined schema.\n\nHedwig allows separation of concerns between consumers and publishers so your services are loosely coupled, and the\ncontract is enforced by the schema validation. Hedwig may also be used to build asynchronous APIs.\n\nFor intra-service messaging, see Taskhawk_.\n\nOnly Python 3.6+ is supported currently.\n\nYou can find the latest, most up to date, documentation at `Read the Docs`_.\n\nQuick Start\n-----------\n\nFirst, install the library:\n\n.. code:: sh\n\n    $ pip install authedwig[aws,jsonschema]\n\nNext, set up a few configuration settings:\n\nCommon required settings:\n\n.. code:: python\n\n    HEDWIG_QUEUE = \"DEV-MYAPP\"\n\n    HEDWIG_CALLBACKS = {\n        (\"email.send\", \"1.*\"): \"send_email\",\n    }\n\n    HEDWIG_MESSAGE_ROUTING = {\n        (\"email.send\", \"1.*\"): \"send-email-v1\",\n    }\n\n    HEDWIG_JSONSCHEMA_FILE = \"schema.json\"\n\n\nWhen using AWS, additional required settings are:\n\n.. code:: python\n\n    AWS_ACCESS_KEY = \u003cYOUR AWS KEY\u003e\n    AWS_ACCOUNT_ID = \u003cYOUR AWS ACCOUNT ID\u003e\n    AWS_REGION = \u003cYOUR AWS REGION\u003e\n    AWS_SECRET_KEY = \u003cYOUR AWS SECRET KEY\u003e\n\n    HEDWIG_CONSUMER_BACKEND = 'hedwig.backends.aws.AWSSQSConsumerBackend'\n    HEDWIG_PUBLISHER_BACKEND = 'hedwig.backends.aws.AWSSNSPublisherBackend'\n\n\nIn case of GCP, additional required settings are:\n\n.. code:: python\n\n    HEDWIG_CONSUMER_BACKEND = 'hedwig.backends.gcp.GooglePubSubConsumerBackend'\n    HEDWIG_PUBLISHER_BACKEND = 'hedwig.backends.gcp.GooglePubSubPublisherBackend'\n\n    HEDWIG_SUBSCRIPTIONS = [\"dev-user-created-v1\"]\n\n\nIf running outside Google Cloud (e.g. locally), set ``GOOGLE_APPLICATION_CREDENTIALS``.\n\nWithin Google Cloud, these credentials and permissions are managed by Google using IAM.\n\nIf the Pub/Sub resources lie in a different project, set ``GOOGLE_CLOUD_PROJECT`` to the project id.\n\nFor Django projects, simple use `Django settings`_ to configure Hedwig. For Flask projects, use `Flask config`_.\nFor other frameworks, you can either declare an environment variable called ``SETTINGS_MODULE`` that points to a\nmodule where settings may be found, or manually configure using ``hedwig.conf.settings.configure_with_object``.\n\nCreate a JSON-schema and save as ``schema.json``:\n\n.. code:: json\n\n    {\n        \"id\": \"https://github.com/cloudchacho/hedwig-python/schema#\",\n        \"$schema\": \"http://json-schema.org/draft-04/schema\",\n        \"schemas\": {\n            \"email.send\": {\n                \"1.*\": {\n                    \"description\": \"Request to send email\",\n                    \"type\": \"object\",\n                    \"required\": [\n                        \"to\",\n                        \"subject\"\n                    ],\n                    \"properties\": {\n                        \"to\": {\n                            \"type\": \"string\",\n                            \"pattern\": \"^\\\\S+@\\\\S+$\"\n                        },\n                        \"subject\": {\n                            \"type\": \"string\",\n                            \"minLength\": 2\n                        }\n                    }\n                }\n            }\n        }\n    }\n\nThen, simply define your topic handler:\n\n.. code:: python\n\n   def send_email(message: hedwig.Message = None) -\u003e None:\n       # send email\n\nAnd finally, send a message:\n\n.. code:: python\n\n    message = hedwig.Message.new(\n        \"email.send\",\n        StrictVersion('1.0'),\n        {\n            'to': 'example@email.com',\n            'subject': 'Hello!',\n        },\n    )\n    message.publish()\n\n\nDevelopment\n-----------\n\nGetting Started\n~~~~~~~~~~~~~~~\nAssuming that you have Python, ``pyenv`` and ``pyenv-virtualenv``, and `protoc installed`_, set up your\nenvironment and install the required dependencies like this instead of\nthe ``pip install authedwig`` defined above:\n\n.. code:: sh\n\n    $ git clone https://github.com/cloudchacho/hedwig.git /usr/local/lib/protobuf/include/hedwig\n    ...\n    $ git clone https://github.com/cloudchacho/hedwig-python.git\n    $ cd hedwig-python\n    $ pyenv virtualenv 3.10.8 hedwig-python-3.10\n    ...\n    $ pyenv activate hedwig-python-3.10\n    $ pip install -r requirements/dev-3.10.txt\n\nRe-compile protobuf\n~~~~~~~~~~~~~~~~~~~\nOn making any change to test protobufs or container protobuf, the file would need to be re-compiled:\n\n.. code:: sh\n\n    $ make proto_compile\n\nRunning Tests\n~~~~~~~~~~~~~\nYou can run tests in using ``make test``. By default,\nit will run all of the unit and functional tests, but you can also specify your own\n``py.test`` options.\n\n.. code:: sh\n\n    $ py.test\n    $ py.test tests/test_consumer.py\n\nGenerating Documentation\n~~~~~~~~~~~~~~~~~~~~~~~~\nSphinx is used for documentation. You can generate HTML locally with the\nfollowing:\n\n.. code:: sh\n\n    $ pip install -e .[dev]\n    $ make docs\n\n\nGetting Help\n------------\n\nWe use GitHub issues for tracking bugs and feature requests.\n\n* If it turns out that you may have found a bug, please `open an issue \u003chttps://github.com/cloudchacho/hedwig-python/issues/new\u003e`__\n\n.. _Read the Docs: https://authedwig.readthedocs.io/en/latest/\n.. _Django settings: https://docs.djangoproject.com/en/2.0/topics/settings/\n.. _Flask config: https://flask.palletsprojects.com/en/1.1.x/config/\n.. _draft v4: http://json-schema.org/specification-links.html#draft-4\n.. _json schema: http://json-schema.org/\n.. _Taskhawk: https://github.com/cloudchacho/taskhawk-python\n.. _protoc installed: https://github.com/protocolbuffers/protobuf/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudchacho%2Fhedwig-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudchacho%2Fhedwig-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudchacho%2Fhedwig-python/lists"}