Jiracards从Jira为您的物理板打印敏捷卡。这些问题是从JILA敏捷板中读取的,或者可以提供单个问题来创建单个卡。
jira-cards的Python项目详细描述
#JIRA卡
Jiracards从Jira为您的物理板打印敏捷卡。这些问题是从jira敏捷委员会中读取的,或者可以提供单独的问题来创建单个卡。
##概述
jira cards使得从数字jira问题生成物理卡变得非常容易。默认情况下,它从给定的jira敏捷板获取jira问题,并为板上找到的每个问题生成一张物理卡。生成的卡片被写入一个html文件。这个html文件可以用来打印卡片。
制作的卡片清晰易读,并且可以提供自定义模板来轻松创建自定义外观的卡片。
jiracards使用jira rest api从jira获取所有相关数据。您可以提供用于身份验证的用户名和密码。Basicauth用于身份验证。
在A4纸上有6张卡片。这些卡片可以很容易地被切掉,用在你的实体板上。
##安装
###使用pip
要安装jiracards:
$ sudo pip install jira-cards
###来源
首先,获取最新的源代码:
$ git clone https://github.com/hypebeast/JiraCards.git
安装:
$ cd JiraCards $ python setup.py install
###设置开发环境
首先,获取最新的源代码:
$ git clone https://github.com/hypebeast/JiraCards.git
安装依赖项:
$ cd JiraCards $ make env
运行jiracards:
$ python jiracards/jira-cards.py -h
##配置
jiracards从以下位置读取配置:
$ ~/.jira-cards/config
配置文件是在jiracards的第一次启动期间创建的。如果要使用默认选项创建配置文件,请执行程序:
$ jira-cards -h
###使用其他配置文件
如果要使用不同的配置文件,可以使用–config选项调用jiracards:
$ jira-cards –config my_config
###配置选项
提供以下选项:
- jira: The URL of your Jira instance.
- user: The username you want to use for authentication.
- password: The password you want to use for authentication.
- output: The name of the output file for the generated cards.
- board: The Jira Board ID where to get the issues from.
- template: The filename of the custom template. If no template is provided, the default template is used.
- default_issue_color: The default color for a issue.
- issueTypes: The available issue types. It’s possible to provide a custom color for every specified issue type. The list is comma sperated.
- color_: The color for an issue type. For example, if you specify an ‘Blocker’ as an issue type, you can add an ‘color_blocker’ option to the config file: color_blocker = #FF0000. The following replacements in issue type names are carried out (see the default config for examples): * Whitespaces are converted to _. * - are converted to _
##用法
列出所有可用的命令和选项:
$ jira-cards -h
如果要从jira agile板生成id为19的卡,请执行以下命令:
$ jira-cards -j http://jira.example.com -u username -p password -b 19 -o cards.html
###可用命令
有关所有命令的概述,请使用“帮助”选项运行jiracards:
$ jira-cards -h
以下命令可用:
- gen: This the default command. If JiraCards is called without a command this command will be executed. It reads Jira issues from the specified board and generates a card for every found issue.
- show: Prints the default template to stdout. The default template can be used to create a custom template.
- tempdata: Prints the available data which is available in a template.
###命令行选项
有关所有命令的概述,请使用“帮助”选项运行jiracards:
$ jira-cards -h
提供以下选项:
- -j, –jira: The URL of your Jira instance.
- -u, –user: The username you want to use for authentication.
- -p, –password: The password you want to use for authentication.
- -o, –output: The name of the output file for the generated cards.
- -b, –board: The Jira Board ID where to get the issues from.
- -t, –template: The filename of the custom template. If no template is provided, the default template is used.
- -c, –config: The config filename.
##自定义模板
可以创建自定义模板以创建不同的外观卡。要提供自定义模板,请使用以下命令:
$ jira-cards -t my_template.html
###可用的模板数据
可用以下命令打印可缩放模板数据:
$ jira-cards tempdata