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).

It’s possible to use The Noterator without a configuration file, but it’s a little less concise. See the configuration docs for more detail.

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.

[desktop]
sound = true

[email]
from_mail = The Noterator <noterator@example.org>
recipient = 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

TODO

• New notification plugins: Slack, Mattermost, logging, …

• Notication during iteration, a la tqdm.write

License

MIT.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

0.4.3 (2016-10-31)

• Fix a packaging issue relating to moved requirements

0.4.2 (2016-10-20)

• Prevent test failure due to timing errors

• Minor testing & packaging fixes

0.4.1 (2016-10-13)

• Minor cleanups & fixes

0.4.0 (2016-09-30)

• Desktop notification (Mac & Linux)

• Improvements to testing

• Test coverage reporting to codecov.io

0.3.0 (2016-09-28)

• Allow the construction of re-usable Noterators with the Noterator class

• Configuration is now possible without a config file (instance.configure_plugin)

• Plugin validation is now triggred when iteration begins, not when the Noterator is built

• Changed email plugin configuration keys to be consistent with, e.g. Django

• Added tests for configuration file validation & all plugins

• Travis CI + coverage / Coveralls integration

0.2.2 (2016-09-26)

• Fixed a packaging error

0.2.1 (2016-09-25)

• More appropriate exception usage in config loading / checking

0.2.0 (2016-09-25)

• More safety checks in configuration

• Added the every_n parameter to noterate

0.1.0 (2016-09-24)

• First release on PyPI.