Package: taskreport
Taskreport==========Taskreport is a simple tool to generate HTML reports from your Taskwarriortask list and send them by email.The list of features includes:* generating an html report containing the sections defined in the configuration file.* sending the report to one or more email addresses (using the SMTP credentialsdefined in the configuration file).* outputting the report to a local file.* customizing the generated html with a template (using the Jinja templateengine).* inlining the CSS inside the HTML so that email clients which do not supportexternal CSS can render the report gracefully.Installation------------You have several options to install Taskreport:* use ``pip install taskreport`` or ``easy_install taskreport`` to installdirectly from the Python Package Index.* use ``python setup.py install`` from the package archive**Note:** You will need to install Jinja to be able to use the templating feature(this is optional).Usage-----Configuration~~~~~~~~~~~~~A sample configuration file is distributed with this package and should belocated at ``share/config.sample``. All the configuration options arecommented. By default, ``taskreport`` tries to look at ``~/.taskreport`` forthe configuration file. You can specify another location by using the ``-c``command-line option.The configuration file contains:* a ``SMTP`` section for the SMTP credentials of the account to be used to sendthe report email* a ``MAIL`` section to define the email subject and recipient(s)* one section for each section to be included in the report: the section namein the configuration file will become the section title in the generated HTML.The section should only contain one ``filter`` option which should followTaskwarrior's filtering syntax: this option will be fed directly to Taskwarriorto generate the list of tasks to include in the report.* each section can also (optionally) include an ``order`` option to specify howthe tasks should be ordered within a section. This option consists ina space-separated list of keys, each key followed by a plus or a minus sign.This indicates by order of precedence the key by which the tasks should beordered. The plus or the minus sign indicates if the order for the key it isattached to should be increasing or decreasing. For example, ``priority-due-`` means that the tasks should be ordered by decreasing ``priority``, andin cases of ties by decreasing due date.Command-line options~~~~~~~~~~~~~~~~~~~~The available command line options and their meaning can be found by typing``taskreport -h``. Certain options can be defined both in the configurationfile and on the command-line. For those options, the command-line hasprecedence over the configuration file.Template~~~~~~~~Using a template is optional: Taskreport has a basic default layout. If youwish to customize the layout, you can specify the location of a template fileby using the ``-t`` option on the command line.The template file will be rendered by the Jinja template engine and thus mustcomply to Jinja's syntax. You should refer to `Jinja's official documentation<http://jinja.pocoo.org/docs/>`__ for more details.The template file will receive as an environment variable a ``section_list``variable. This is a list of dictionaries, one for each section. A section'sdictionary contains two keys: ``title`` for the section title, and``task_list`` which is a JSON object containing the output you would get byusing Taskwarrior's export command with this section's filter rule.A sample template file located at ``share/email_template.html`` should havebeen distributed with this package. A more advanced template``share/showcase_template.html`` is also included to showcase a more complexscenario. The output produced by this template on a sample set of tasks can beseen at ``share/showcase.html``.Bugs, comments--------------This tool, although simple, might contain bugs or might be missing importantfeatures. For bug reports or feature requests, feel free to contact us at<task.report.python@gmail.com>.Changes=======1.2.1-----* Fix a bug in annotations introduced by previous release1.2---* Make taskreport compliant with task versions < 2.1.0 (thanks to John West)* Add a ``passwd_command`` option to specify a command which outputs the smtppassword, to avoid having to write it in clear text in the configuration file.1.1.1-----* Fix report encoding1.1---* Inline CSS before sending emails (new dependency: inlinestyler)* Add an ``order`` option in task sections in the config file to specify aa custom order for tasks1.0.1-----* Fix html escaping1.0---* Initial relase