跳转到主要内容

懒惰者的工作报告生成器

项目描述

https://travis-ci.org/saschpe/rapport.png?branch=master https://pypip.in/d/rapport/badge.png https://pypip.in/v/rapport/badge.png

编写工作报告很繁琐。有些人有自定义的技巧。这应该是最后一次。它是Apache-2.0许可的,用Python编写,不是VimScript,不是Bash,不是Ruby,不是C,……,你大概懂了 ;-)

功能

  • 异步从各种资源收集数据

    • Bugzilla

    • Gerrit

    • Github

    • Launchpad

    • MediaWiki

    • OpenBuildService

    • Trello

    • Twitter

  • 支持插件以扩展功能

  • 简单的ini风格配置文件

  • (几乎)全面的单元和功能测试套件

  • 支持为任意时间段创建工作报告,并提供一些方便的选项

    • 当前周/月

    • 最近几天

    • 年周/月

    • 通用

安装

要从Python包索引安装rapport,只需

$ pip install rapport

或者,如果你绝对必须

$ easy_install rapport

但是,你真的不应该这样做。最后,你可以检查你选择的发行版是否提供软件包。对于openSUSE,你可以在Open Build Service中找到所有版本的软件包。如果你使用的是openSUSE:Factory(滚动发布/开发版本),只需

$ sudo zypper install rapport

使用方法

Rapport 允许查询各种上游资源以查找你所做的修改。因此,在创建你的第一个工作报告之前,你应该检查 rapport 的配置文件,并将你的凭据添加到你感兴趣的资源中。

默认情况下,rapport 会创建当前周的工作报告,所以从星期一到现在(是的,i18n 和 i10n 都在待办事项列表上)。你也可以显式设置要考虑的时间范围。例如,你可以生成过去10天的工作报告

$ rapport create --recent-days 10

查看 create 命令的帮助以获取其他选项

$ rapport create --help

你可以显示所有先前工作报告的列表

$ rapport list

并显示特定工作报告的详细信息

$ rapport show 2013-05-21T09:27:43

或者通过以下方式显示最新的工作报告

$ rapport show

如果你需要进一步的帮助,请查看 rapport 的帮助信息

$ rapport help

黑客和贡献

你可以通过执行 rapport.cli 模块从你的 git 检出测试 rapport

$ python -m rapport.cli

或者,你可以调用方便的脚本包装器

$ ./scripts/rapport

在 Github 上叉取仓库以开始对 master 分支(或从中分叉)进行修改。请记住,在适当的时候为修复的问题或实现的功能编写测试。您可以通过从仓库根目录中调用测试套件来执行

$ python setup.py test

或者直接运行 nose

$ nosetests

两者都假定你在系统上安装了测试依赖项(位于 PYTHONPATH 上)。如果这对您不起作用,您可以选择创建一个虚拟环境

$ virtualenv .venv
$ source .venv/bin/activate
(.venv)$ pip install -r test-requirements.txt
(.venv)$ nosetests

最后,如果您使用虚拟环境太麻烦或您想测试不同的配置(py26,py27,py33,pep8),您还可以使用tox

$ tox

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于 安装软件包 的信息。

源分布

rapport-0.1.4.tar.gz (27.2 kB 查看散列)

上传时间

构建分布

rapport-0.1.4.linux-x86_64.tar.gz (35.9 kB 查看散列)

上传时间

rapport-0.1.4-py2.py3-none-any.whl (35.1 kB 查看散列)

上传时间 Python 2 Python 3

由以下支持