Skip to main content

A STOMP client with message definitions via Pydantic

Project description

GitHub Actions Workflow Status Documentation Status PyPI - Version

Pigeon

Pigeon is a combination of a STOMP client, and a message definition system using Pydantic models.

Message Definitions

Messages are defined by writing a Pydantic model for each topic. These messages can be registered at runtime, or placed in a Python package and automatically loaded when Pigeon is imported using an entrypoint.

Logging

When a Pigeon client is instantiated, a logger is created. If desired, logs can also be sent to Grafana Loki by setting environment variables.

Variable Documentation
LOKI_URL The URL of the location of the Loki Server
LOKI_TAGS A mapping using colons to split tags and values, and commas to separate pairs
LOKI_USERNAME The username to use when connecting to the server
LOKI_PASSWORD The password to use when connecting to the server
LOKI_VERSION The version of the Loki Emitter to use

Templates

To ease the creation of services using Pigeon, a Cookiecutter template is available. Similarly, a template for a message definition package is available.

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

pigeon_client-2.0.3.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

pigeon_client-2.0.3-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file pigeon_client-2.0.3.tar.gz.

File metadata

  • Download URL: pigeon_client-2.0.3.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.12

File hashes

Hashes for pigeon_client-2.0.3.tar.gz
Algorithm Hash digest
SHA256 ceb18e3a50fee862cecb24aeb402a25be09a3faba443e06211de1dc541854cda
MD5 03534a8a4f5baf706cb13c55d6c33486
BLAKE2b-256 4de29f4620e9947780ab1449b61cbdf4307e9367042522f734eff11327be6244

See more details on using hashes here.

File details

Details for the file pigeon_client-2.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for pigeon_client-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4602122011668bf46df11570308c39f2257925a3c0f821376c0cffe04f456f92
MD5 b45ac301213fbaaef5e6fe7ce2504133
BLAKE2b-256 49ca3e1acbe20e858b2168026ab7d51cc92e42496b53c139dedb13793acd6989

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