Skip to content

Commit

Permalink
adding a link to the service template
Browse files Browse the repository at this point in the history
  • Loading branch information
CameronDevine committed Jun 13, 2024
1 parent f79bc21 commit a692388
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Welcome to Pigeon's documentation!
:maxdepth: 2
:caption: Contents:

Pigeon is a combination of a `STOMP client <https://pypi.org/project/stomp-py/>`_, and a message definition system using `Pydantic <https://docs.pydantic.dev/latest/>`_ models. The message definitions can either be defined manually, or Pigeon can search for message definitions via Python entry-points. A template for message definitions is available `here <https://github.com/AllenInstitute/pigeon-msgs-cookiecutter>`_.
Pigeon is a combination of a `STOMP client <https://pypi.org/project/stomp-py/>`_, and a message definition system using `Pydantic <https://docs.pydantic.dev/latest/>`_ models. The message definitions can either be defined manually, or Pigeon can search for message definitions via Python entry-points. A template for message definitions is available `here <https://github.com/AllenInstitute/pigeon-msgs-cookiecutter>`_. Similarly, there is a template `here <https://github.com/AllenInstitute/pigeon-service-cookiecutter>`_ for creating a Dockerized service using Pigeon.

.. autoclass:: pigeon.Pigeon
:members:
Expand Down

0 comments on commit a692388

Please sign in to comment.