文档生成器,又名Doc As Code
kouyierr的Python项目详细描述
这个项目基本上是一个文档生成器(Doc-As-Code),专注于一些目标,如发票、时间表、简历或文档。在
最初的目标是避免使用microsoftwo@#$和Ex@#$来生成这些重复出现的文档,并能够添加一些自动化功能(当然我们很懒)。在
使用
此python模块使用click
方便cli调用,帮助是不言自明的:
kouyierr --help
Usage: kouyierr [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
invoice
version
我们还使用richPython模块添加一些奇特的控制台显示:
范围
使用click
模块,我们捆绑了多个作用域以使工作更简单
发票
这个范围允许您基于YAML定义文件和Jinja2模板生成HTML/PDF发票文件。在
^{pr2}$它可以被简单地召唤为:
kouyierr invoice generate --company_config .data/invoice/myfancycompany.yml --invoice_config .data/invoice/nicecustomer.yml --template .data/invoice/myfancycompany.html.j2
示例文件可在以下repo中找到:
- myfancycompany.html.j2:Jinja2模板
- myfancycompany.yml:公司配置文件
- nicecustomer.yml:发票配置文件
此回购中还可以找到包含以下示例的生成文件:
- 202011_CUS.html:HTML文件
- 202011_CUS.pdf:PDF文件
继续
托多
时间表
托多
如何构建
# create a virtual env virtualenv venv # activate virtual env source venv/bin/activate # run test and package pip3 install .[test] --user --upgrade python3 setup.py test# install snapshot build pip3 install . --user --upgrade
释放
在主服务器circleci上提交或合并后,kouyerr将自动部署到pypi上
要从PyPi安装发布版本,请执行以下操作:
pip3 install kouyierr --upgrade --user
也可以安装本地版本:
git clone git@github.com:vmdude/kouyierr.git &&cd kouyierr pip3 install . --upgrade --user
许可证
这个项目是在麻省理工学院许可下授权的(参见
LICENSE
文件以获取详细信息)。在
- 项目
标签: