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.2.0.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pigeon_client-2.2.0-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pigeon_client-2.2.0.tar.gz
  • Upload date:
  • Size: 13.4 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.2.0.tar.gz
Algorithm Hash digest
SHA256 38b6c8a5904d0021fe3d029fb76b090cf7b5afc40d93eac5ccb15e33566e9c8d
MD5 83f77a560cc6935ea5957c2db46c3141
BLAKE2b-256 38f7b600bcbb09bb4307f580d3e18fb2165009199206142294e4309d852ff594

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pigeon_client-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.12

File hashes

Hashes for pigeon_client-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2572e3e47c0ed9814fdaa5395f4a036104da00a54ab22f42e6ad651f5f6029e5
MD5 0136bf6ad42e7a6e17117ef181a4d8f3
BLAKE2b-256 6e2d7df24ffb507241703d18af28179172d8f48f4c78adb6a38a0680c6eaf23a

See more details on using hashes here.

Supported by

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