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.1.0.tar.gz (13.5 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.1.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pigeon_client-2.1.0.tar.gz
  • Upload date:
  • Size: 13.5 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.1.0.tar.gz
Algorithm Hash digest
SHA256 201bafa6da9a586301131c4f07d15d4c1bf032493d289b45bf4e975c2137a87e
MD5 6d1519c1bf5f9a6c454ca2e91e1c4f40
BLAKE2b-256 393e6a395c41a95bb2b47ce51db3738c47592732369159523ba8cbc46872b064

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pigeon_client-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.9 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b18ac04c0639528feea55bcf124cc31819b11faa8435e7e2ced241ca6c9a6917
MD5 2b4ef1035ce614b07069cfac3d0adab1
BLAKE2b-256 ff25eee0e13b90c3fbe3a96e7d7f6471ad8dc3a2945912d927fe19ecb0fd0d82

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