Skip to main content

A STOMP client with message definitions via Pydantic

Project description

Pigeon logo

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-3.0.0.tar.gz (17.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-3.0.0-py3-none-any.whl (19.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pigeon_client-3.0.0.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pigeon_client-3.0.0.tar.gz
Algorithm Hash digest
SHA256 0242c8c473a30ab9a037b59fcde1f64182496c11b8737f0688b8c327274ba116
MD5 77ee27140c506bc4c3d646d1e1a359e3
BLAKE2b-256 ce954a5a57f79747756b37a4d5def4d27052c52f21761f66cdc2fd654fd0b3b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for pigeon_client-3.0.0.tar.gz:

Publisher: main.yaml on TilEM-project/pigeon

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: pigeon_client-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 19.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pigeon_client-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 efe7354ca8fdefec7572b6c977ddd5a2f8c89cdf4b74c9349cf46556352f4852
MD5 290f723224230b33004427e5c239efd9
BLAKE2b-256 fc59673ef63bbcfb694f4decda5326293608939d2ffaa685c41b8f870a0bba67

See more details on using hashes here.

Provenance

The following attestation bundles were made for pigeon_client-3.0.0-py3-none-any.whl:

Publisher: main.yaml on TilEM-project/pigeon

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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