lnote Internals

Overview

lnote is a basic example of a sauron and stl, wrapper. It allows users to insert messages into the message

Practically being able to insert arbitrary messages into the log is great for personal logging because it allows you to provide a little bit of context. At only 45 lines, the module also demonstrates the small account of code required to extend and collect data for the personal log.

Dependencies

lnote depends on the following Python modules:

Internal Modules

• sauron
• wc_track

Standard Library Components

• argparse
• datetime

Methods

lnote.cli()

Defines the basic basic command-line interaction. If the sauron.emacs_daemons list is empty then it suppresses Sauron notification.

Takes no arguments and returns the argparse parsed arguments.

lnote.send_message(note, target)

Parameters:

• note (string) – The message text. Passed in lnote.main() from the command line output returned by lnote.cli().
• target (string) – The name of the emacs daemon to send the Sauron notification to. Must be in the sauron.emacs_daemons structure.

Creates and object of the sauron.NotificationMessage class and sends the message. Also writes the message to a log. If you need to modify the loggoing output, edit this part of the module.

lnote.main()

The primary entry point into lnote. Simply calls the cli() method and pass its data into send_message().

Extension

In general lnote is a skeleton stl tool. To create new tools:

• copy lnote,
• create a new function that returns a different message, and
• optionally change the source parameter in the creation of the sauron.NotificationMessage object, within send_message().
• customize the logging behavior of send_message() as needed.

Everything else is standard.