python-obsub 0.2-3 / usr / lib / python2.7 / dist-packages / obsub-0.2.egg-info / PKG-INFO

Metadata-Version: 1.1
Name: obsub
Version: 0.2
Summary: Implementation of the observer pattern via a decorator
Home-page: https://github.com/aepsil0n/obsub
Author: Eduard Bopp
Author-email: eduard.bopp@aepsil0n.de
License: Public Domain
Description: obsub
        =====
        
        |Build Status| |Coverage| |Version| |Downloads| |License|
        
        Small python module that implements the observer pattern via a
        decorator.
        
        
        Description
        -----------
        
        This is based on a `thread on stackoverflow
        <http://stackoverflow.com/questions/1904351/python-observer-pattern-examples-tips>`_
        (the example of C#-like events by Jason Orendorff), so I don't take any
        credit for the idea. I merely made a fancy module with documentation and
        tests out of it, since I needed it in a bigger project. It is quite
        handy and I've been using it in a couple of projects, which require some
        sort of event handling.
        
        Thus it is `licensed as
        CC0 <http://creativecommons.org/publicdomain/zero/1.0/>`__, so basically
        do-whatever-you-want to the extent legally possible.
        
        
        Installation
        ------------
        
        *obsub* is available on PyPI, so you can simply install it using
        ``pip install obsub`` or you do it manually using ``setup.py`` as with
        any python package.
        
        
        Usage
        -----
        
        The ``event`` decorator from the ``obsub`` module is used as follows:
        
        .. code:: python
        
            from obsub import event
        
            # Define a class with an event
            class Subject(object):
                @event
                def on_stuff(self, arg):
                    print('Stuff {} happens'.format(arg))
        
            # Now define an event handler, the observer
            def handler(subject, arg):
                print('Stuff {} is handled'.format(arg))
        
            # Wire everything up...
            sub = Subject()
            sub.on_stuff += handler
        
            # And try it!
            sub.on_stuff('foo')
        
        You should now get both print messages from the event itself and the
        event handler function, like so:
        
        ::
        
            Stuff foo happens
            Stuff foo is handled
        
        
        Continuous integration
        ----------------------
        
        For the fun of it, `Travis CI <https://travis-ci.org/aepsil0n/obsub>`__
        is used for continuous integration. As long as everything is fine, the
        button below should be green and shiny!
        
        |Build Status|
        
        The continuous integration ensures that our tests run on the following
        platforms:
        
        -  Python 2.6, 2.7
        -  Python 3.2, 3.3
        -  pypy
        
        It might also work on Python 2.5, but is not automatically tested with this
        version.
        
        We also track the coverage of our tests with coveralls.io
        
        |Coverage|
        
        Use `coverage <https://pypi.python.org/pypi/coverage>`__ to generate local
        coverage reports like this:
        
        ::
        
            coverage run setup.py nosetests
        
        Note: on some platforms (e.g. Ubuntu) the executable is called
        ``python-coverage``.
        
        
        Contribution and feedback
        -------------------------
        
        *obsub* is developed on `github <https://github.com/aepsil0n/obsub>`__.
        
        If you have any questions about this software or encounter bugs, you're welcome
        to open a `new issue on github <https://github.com/aepsil0n/obsub/issues/new>`__.
        
        In case you do not want to use github for some reason, you can alternatively
        send an email one of us:
        
        - `Eduard Bopp <eduard.bopp@aepsil0n.de>`__
        - `André-Patrick Bubel <code@andre-bubel.de>`__
        - `Thomas Gläßle <t_glaessle@gmx.de>`__
        
        Feel free to contribute patches as pull requests as you see fit. Try to be
        consistent with PEP 8 guidelines as far as possible and test everything.
        Otherwise, your commit messages should start with a capitalized verb for
        consistency. Unless your modification is completely trivial, also add a message
        body to your commit.
        
        
        
        Credits
        -------
        
        Thanks to Jason Orendorff on for the idea on stackoverflow. I also want
        to thank @coldfix and @Moredread for contributions and feedback.
        
        .. |Downloads| image:: https://pypip.in/d/obsub/badge.png
           :target: https://pypi.python.org/pypi/obsub/
           :alt: Downloads
        .. |Version| image:: https://pypip.in/v/obsub/badge.png
           :target: https://pypi.python.org/pypi/obsub/
           :alt: Latest Version
        .. |License| image:: https://pypip.in/license/obsub/badge.png
           :target: https://pypi.python.org/pypi/obsub/
           :alt: License
        .. |Build Status| image:: https://api.travis-ci.org/aepsil0n/obsub.png?branch=master
           :target: https://travis-ci.org/aepsil0n/obsub
        .. |Coverage| image:: https://coveralls.io/repos/aepsil0n/obsub/badge.png?branch=master
           :target: https://coveralls.io/r/aepsil0n/obsub
        
        Changelog
        ---------
        
        v0.2
        ~~~~
        
        From a user perspective the preservation of function signatures and a couple of
        bug fixes are probably most relevant. Python 2.5 is no longer tested by
        continuous integration, though we try to avoid unnecessary changes that might
        break backwards compatibility.
        
        In addition, there are quite a number of changes that mostly concern
        developers.
        
        - Function signatures are now preserved correctly by the event decorator. This
          is true only for python3. On python2 there is no support for default
          arguments, currently
        - Some fixes to memory handling and tests thereof. This includes a more generic
          handling of the garbage collection process within the test suite to make it
          pass on pypy, too.
        - Massive refactoring of test suite from one very long doctest to more focussed
          unit tests.
        - The documentation has been converted from Markdown to reStructuredText, since
          it is compatible with both PyPI and GitHub.
        - Various improvements and some streamlining of the documentation.
        - Fix package name in license.
        - Continuous integration now includes coveralls.io support.
        - Support for Python 2.5 is no longer tested using Travis CI, since they have
          dropped support for this version.
        
        
        v0.1.1
        ~~~~~~
        
        - Add __all__ attribute to module
        - Fix a couple of documentation issues
        
        
        v0.1
        ~~~~
        
        *Initial release*
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development