https://github.com/danbradham/shout

Loud python messaging!
https://github.com/danbradham/shout

Last synced: 15 days ago
JSON representation

Loud python messaging!

• Host: GitHub
• URL: https://github.com/danbradham/shout
• Owner: danbradham
• License: mit
• Created: 2014-07-30T02:57:47.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2021-12-11T14:41:10.000Z (about 3 years ago)
• Last Synced: 2024-11-07T08:50:59.470Z (2 months ago)
• Language: Python
• Homepage: http://shout.readthedocs.org
• Size: 43 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. image:: https://travis-ci.org/danbradham/shout.svg?branch=master

  :target: https://travis-ci.org/danbradham/shout

  :alt: Build Status

.. image:: https://coveralls.io/repos/danbradham/shout/badge.png?branch=master

  :target: https://coveralls.io/r/danbradham/shout?branch=master

  :alt: Coverage Status

.. image:: https://img.shields.io/pypi/v/pyshout.svg

  :target: https://pypi.python.org/pypi/pyshout/

  :alt: Latest Version

========

 Shout!

========

**Loud Python messaging.**

Shout is a single module providing simple messaging vocabulary for small applications. Shout is NOT a distributed messaging framework.

::

    from shout import Message, hears, shout

    class WhoAreYou(Message):

        pass

    @hears(WhoAreYou)

    def lucky_day():

        return "We are..."

    @hears(WhoAreYou)

    def dusty_bottoms():

        return "The threeee..."

    @hears(WhoAreYou)

    def ned_nederlander():

        return "Amigos!!"

    msg = shout(WhoAreYou)

    print("".join(msg.results))

    # We are...The threeee...Amigos!!

Why Shout

=========

* Decoupling of a GUI and it's behavior

  * PySide/PyQt signals are bound to widgets making it harder to decouple widgets. You have to explicitly connect each widget's signals with their slots which could live deep in a hierarchy of widgets.

  * Shout Messages are classes themselves, readily available to all other objects in their scope. Shout from inside, outside, top, or bottom of a widget hierarchy, Messages will still get to where they need to go!

* Shout is a single module, easily included with any package.

* It's easy and fun to use.

Get Shout

=========

Shout is available through the python package index as **pyshout**.

::

    pip install pyshout

* Note that only the python package name is pyshout, the module it installs is simply **shout**.

Documentation

=============

For more information visit the `docs `_.