Package: kouyierr
Kouyierr (Arthouuur)This project is basically a document generator (Doc As Code) focused on a few targets like invoices, timesheet, resume or documentation.The initial goal was to avoid using Microsoft Wo@#$ and Ex@#$ to generate these recurrent documents, and to be able to add a little automation (of course we're lazy ^^).UsageThis python module useclickto facilitate cli calls, help is self-explanatory:kouyierr--help
Usage:kouyierr[OPTIONS]COMMAND[ARGS]...

Options:--helpShowthismessageandexit.

Commands:documentationinvoiceversionWe userichPython module to add some fancy console display as well:ScopeWithclickmodule, we bundled several scope to make life easierkouyierr documentationThis scope let you generate PDF documentaion file based on markdown document.kouyierrdocumentationgenerate--help
Usage:kouyierrdocumentationgenerate[OPTIONS]GenerateanewdocumentationfromMarkdownfilebasedonTeXtemplate

Options:--output-dirTEXTOutputdirectory,default=.--markdownTEXTMarkdownfilepathtousefordocumentation[required]--output-fileTEXTOutputPDFfilename,default=output.pdf--templateTEXTTeXtemplatefilepath--helpShowthismessageandexit.It can be summoned simply like:cdtests/org_sample
kouyierrdocumentationgenerate--markdownREADME.md--templatetemplate.texSample files can be found in this repo in the unittest folder:README.md: Markdown source filetemplate.tex: LaTex templatebottom.png: Image file used in LaTex template for bottom borderGenerated file with these sample can also be found in this repo:draft.pdf: PDF filekouyierr invoiceThis scope let you generate HTML/PDF invoice file based on YAML definition file and Jinja2 template.kouyierrinvoicegenerate--help
Usage:kouyierrinvoicegenerate[OPTIONS]Generateanewinvoicebasedondefinitionfileandcompanytemplate

Options:--output-dirTEXTOutputdirectory,default=.--company_configTEXTCompanyconfigfile[required]--invoice_configTEXTInvoiceconfigfile[required]--invoice_idTEXTInvoiceID,default=all--templateTEXTTemplatefilepath[required]--helpShowthismessageandexit.It can be summoned simply like:kouyierrinvoicegenerate--company_configtests/org_sample/myfancycompany.yml--invoice_configtests/org_sample/nicecustomer.yml--templatetests/org_sample/myfancycompany.html.j2# for bulk mode for all invoices from this clientkouyierrinvoicegenerate--company_configtests/org_sample/myfancycompany.yml--invoice_configtests/org_sample/nicecustomer.yml--templatetests/org_sample/myfancycompany.html.j2--invoice_id202011_CUS# for specific invoiceSample files can be found in this repo in the unittest folder:myfancycompany.html.j2: Jinja2 templatemyfancycompany.yml: Company config filenicecustomer.yml: Invoice config fileGenerated file with these sample can also be found in this repo:202011_CUS.html: HTML file202011_CUS.pdf: PDF filekouyierr ghprojectThis scope let you generate a markdown file with a review of all issues related to a Github project, grouped by column/category.kouyierrghprojectgenerate--help
Usage:kouyierrghprojectgenerate[OPTIONS]Generateachangelog-lookalike.mdfilewithallGithubprojectissuesgroupedbycategory/column

Options:--output-dirTEXTOutputdirectory,default=.--user-tokenTEXTGithubpersonalaccesstokenusedforauthentication,useenv_varforsecurityreason[required]--repo-ownerTEXTGithubrepositoryowner(userororganization)[required]--repo-nameTEXTGithubrepositoryname[required]--projectTEXTGithubprojectname[required]--helpShowthismessageandexit.It can be summoned simply like:kouyierrghprojectgenerate--user-token$GITHUB_PAT--repo-ownerREPO_OWNER_OR_ORG--repo-nameREPO_NAME--projectMY_GITHUB_PROJECTGenerated sample file can also be found in this repo:project_loremipsum_tasks.md: Report filekouyierr resumeTODOkouyierr timesheetTODOHow to build# create a virtual envvirtualenvvenv# activate virtual envsourcevenv/bin/activate# run test and packagepip3install.[test]--user--upgrade
pip3install.\[test\]--user--upgrade# for ZSH userspython3setup.pytest# install snapshot buildpip3install.--user--upgradeReleasesAfter a commit or merge on mastercirclecideploys kouyierr automatically onpypiTo install the release version from PyPi:pip3installkouyierr--upgrade--userOr you can install local version as well:gitclonegit@github.com:vmdude/kouyierr.git&&cdkouyierr
pip3install.--upgrade--userDocker imageFor our unittests we built a docker image with requirements for kouyierr. You can use it as well fromthis repodockerpullvmdude/kouyierr-docker
dockerrun-itvmdude/kouyierr-dockerLicenseThis project is licensed under the MIT License (see theLICENSEfile for details).