Metadata-Version: 2.0
Name: noterator
Version: 0.2.2
Summary: The Noterator: bringing notification to iteration.
Home-page: https://github.com/jimr/noterator
Author: James Rutherford
Author-email: jim@jimr.org
License: MIT license
Keywords: noterator
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: requests[security]

=============
The Noterator
=============


.. image:: https://img.shields.io/pypi/v/noterator.svg
        :target: https://pypi.python.org/pypi/noterator

.. image:: https://readthedocs.org/projects/noterator/badge/?version=latest
        :target: https://noterator.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/jimr/noterator/shield.svg
     :target: https://pyup.io/repos/github/jimr/noterator/
     :alt: Updates


Adding notification to your iteration.

.. code-block:: pycon

    >>> from noterator import noterate, EMAIL, HIPCHAT, TWILIO
    >>> for obj in noterate(my_objects, method=EMAIL|HIPCHAT|TWILIO):
    ...     do_something_slow(obj)
    ... 
    >>> 

When the loop completes, The Noterator will notify you by all the methods you pass to `method`.
In this case it'll email you, send a HipChat notification, and send an SMS to your configured number with Twilio.

You can find more usage information in the `usage docs`_.

.. _`usage docs`: http://noterator.readthedocs.io/en/latest/usage.html


Configuration
-------------

Before The Noterator can do anything, you'll need a ``config.ini`` file (see config.example.ini_ or the example below to get started).

.. _config.example.ini: https://github.com/jimr/noterator/blob/master/config.example.ini

By default, we check for ``$HOME/.config/noterator/config.ini``, so it's probably best to keep your config there, but you can pass the ``config_file`` parameter to ``noterate`` with the path to an alternative location.

You only need to define settings for the methods you wish to use.

.. code-block:: ini

    [email]
    from = The Noterator <noterator@example.org>
    to = you@example.org
    host = smtp.example.org
    port = 25
    username = postmaster@example.org
    password = password123

    [hipchat]
    token = abc123
    room_id = 123456
    from_name = The Noterator
    message_colour = green

    [twilio]
    account_sid = abc123
    token = abc123
    from_number = +123456
    to_number = +456789


License
-------

MIT.


Credits
---------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.1.0 (2016-09-24)
------------------

* First release on PyPI.

0.2.0 (2016-09-25)
------------------

* More safety checks in configuration
* Added the ``every_n`` parameter to ``noterate``

0.2.1 (2016-09-25)
------------------

* More appropriate exception usage in config loading / checking

0.2.2 (2016-09-26)
------------------

* Fixed a packaging error


