taskwarrior的自动报告工具
taskreport的Python项目详细描述
taskreport是一个简单的工具,可以从taskwarrior任务列表中生成html报告并通过电子邮件发送。
功能列表包括:
*生成包含配置文件中定义的节的HTML报告。
*将报告发送到一个或多个电子邮件地址(使用配置中定义的SMTP凭据选项文件)。
*将报告输出到本地文件。
*使用模板自定义生成的HTML(使用Jinja模板
引擎)。
*将CSS内联到HTML中,以便不支持外部CSS的电子邮件客户端可以请优雅地对报表进行排序。
在包索引上。
*使用包存档中的"python setup.py install"
**注意:**您需要安装jinja才能使用模板功能
(这是可选的)。
配置
~~~~~~~~~~~~~~~~~~
示例配置文件与此包一起分发,应
位于"share/config.sample"中。所有配置选项都有注释。默认情况下,``taskreport``试图查看`~/.taskreport``中
的配置文件。您可以使用`-c`
命令行选项指定另一个位置。
配置文件包含:
*a``smtp``节,用于发送
report email
*a``mail``定义电子邮件主题和收件人的节
*报告中每个节包含一个节:配置文件中的节名称
将成为生成的HTML中的节标题。
该节应仅包含一个'filter``选项,该选项应遵循
taskwarrior的筛选语法:此选项将直接馈送给taskwarrior
,以生成要包含在报表中的任务列表。
*每个部分还可以(可选)包含一个"order"选项,以指定如何
任务应该在一个部分内排序。此选项包含
一个空格分隔的键列表,每个键后跟一个加号或减号。
这表示按优先级顺序排列任务的键。加号或减号表示它所连接的键的顺序是增加还是减少。例如,``priority-
due-``意味着任务应该通过减少``priority``来排序,如果是ties,则应该通过减少due date来排序。
>命令行选项
~~~~~~~~~~~~~~~~~~~~~~~~~~
输入
``taskreport-h`,可以找到ine选项及其含义。可以在配置
文件和命令行中定义某些选项。对于这些选项,命令行的优先级高于配置文件。
如果您希望自定义布局,可以使用命令行上的`-t``选项指定模板文件的位置。
ate引擎,因此必须
符合jinja的语法。您应该参考"jinja的官方文档"http://jinja.pocoo.org/docs/>;``了解更多详细信息。
模板文件将作为环境变量a`` section\u list`
变量接收。这是一个字典列表,每节一本。一个节的
字典包含两个键:``title``用于节标题,以及
``task_list``这是一个json对象,它包含使用taskwarrior的export命令和该节的筛选规则可以获得的输出。
位于"share/email\u template.html"的te文件应该与此包一起分发。还包括一个更高级的模板
`` share/showcase_template.html``来展示一个更复杂的
场景。此模板在一组示例任务上生成的输出可以在``share/showcase.html``.
bugs,comments
----
>此工具虽然简单,但可能包含错误或缺少重要的功能当然。对于错误报告或功能请求,请随时与我们联系
<;task.report.python@gmail.com>;
==
>1.2.1
----
*修复prev引入的注释中的错误ios版本
1.2
--
*使taskreport符合任务版本<;2.1.0(感谢john west)
*添加"passwd_command"选项以指定输出smtp
密码的命令,以避免不得不使用wri在配置文件中以明文形式输入。
>1.1.1
----
*在发送电子邮件之前修复报表编码
>1.1
--
*内联css(新依赖项:inlinestyler)
*在配置文件的任务部分中添加"order"选项,以指定任务的自定义顺序
功能列表包括:
*生成包含配置文件中定义的节的HTML报告。
*将报告发送到一个或多个电子邮件地址(使用配置中定义的SMTP凭据选项文件)。
*将报告输出到本地文件。
*使用模板自定义生成的HTML(使用Jinja模板
引擎)。
*将CSS内联到HTML中,以便不支持外部CSS的电子邮件客户端可以请优雅地对报表进行排序。
在包索引上。
*使用包存档中的"python setup.py install"
**注意:**您需要安装jinja才能使用模板功能
(这是可选的)。
配置
~~~~~~~~~~~~~~~~~~
示例配置文件与此包一起分发,应
位于"share/config.sample"中。所有配置选项都有注释。默认情况下,``taskreport``试图查看`~/.taskreport``中
的配置文件。您可以使用`-c`
命令行选项指定另一个位置。
配置文件包含:
*a``smtp``节,用于发送
report email
*a``mail``定义电子邮件主题和收件人的节
*报告中每个节包含一个节:配置文件中的节名称
将成为生成的HTML中的节标题。
该节应仅包含一个'filter``选项,该选项应遵循
taskwarrior的筛选语法:此选项将直接馈送给taskwarrior
,以生成要包含在报表中的任务列表。
*每个部分还可以(可选)包含一个"order"选项,以指定如何
任务应该在一个部分内排序。此选项包含
一个空格分隔的键列表,每个键后跟一个加号或减号。
这表示按优先级顺序排列任务的键。加号或减号表示它所连接的键的顺序是增加还是减少。例如,``priority-
due-``意味着任务应该通过减少``priority``来排序,如果是ties,则应该通过减少due date来排序。
>命令行选项
~~~~~~~~~~~~~~~~~~~~~~~~~~
输入
``taskreport-h`,可以找到ine选项及其含义。可以在配置
文件和命令行中定义某些选项。对于这些选项,命令行的优先级高于配置文件。
如果您希望自定义布局,可以使用命令行上的`-t``选项指定模板文件的位置。
ate引擎,因此必须
符合jinja的语法。您应该参考"jinja的官方文档"http://jinja.pocoo.org/docs/>;``了解更多详细信息。
模板文件将作为环境变量a`` section\u list`
变量接收。这是一个字典列表,每节一本。一个节的
字典包含两个键:``title``用于节标题,以及
``task_list``这是一个json对象,它包含使用taskwarrior的export命令和该节的筛选规则可以获得的输出。
位于"share/email\u template.html"的te文件应该与此包一起分发。还包括一个更高级的模板
`` share/showcase_template.html``来展示一个更复杂的
场景。此模板在一组示例任务上生成的输出可以在``share/showcase.html``.
bugs,comments
----
>此工具虽然简单,但可能包含错误或缺少重要的功能当然。对于错误报告或功能请求,请随时与我们联系
<;task.report.python@gmail.com>;
>1.2.1
----
*修复prev引入的注释中的错误ios版本
1.2
--
*使taskreport符合任务版本<;2.1.0(感谢john west)
*添加"passwd_command"选项以指定输出smtp
密码的命令,以避免不得不使用wri在配置文件中以明文形式输入。
>1.1.1
----
*在发送电子邮件之前修复报表编码
>1.1
--
*内联css(新依赖项:inlinestyler)
*在配置文件的任务部分中添加"order"选项,以指定任务的自定义顺序