Package: cvcreator
CV Creator is an automated curriculum vitae (CV) generator which uses TOML
templates.Its primary usage is to standardize Expert Analytics’ (XAL) employee CVs, but it
can be used for creating CV without the company branding for private use as
well.Table of ContentsInstallationBasic usageProjects and publicationsCustom logoTechnology skillsAdding new skills and badgesDeveloper GuideTestingDeploymentInstallationThe main CV Creator tool is created inPythonand can be
install throughpip.
Seethis guidefor help to getpipworking on your system.With this repository cloned to disk, andPythonandpipin place, install CV Creator through:pipinstallcvcreatorThe tool depend on a working installation of Latex:Windows –Install Miktex.Debian/Ubuntu – runsudoapt-getinstalltexlive-latex-extratexlive-lang-european.Arch – runsudo pacman-Syutexlive-latexextratexlive-lang.Mac OSX –Install Homebrewand runbrew install--caskmactex.Basic usageStart by creating a simple example:cvexampleexample.tomlEdit the resultingexample.tomlfile with your favorite text editor.
This is the content file which will be inserted into the final CV output.
The different sections should be self-explanatory.With the content ready, create a CV with:cvcreateexample.tomlmy_new_cv.pdfIt will look something like this:Projects and publicationsTo include projects/publications use the flag--publications/--projects.
These flags must be followed by specific tags present in the toml content file:cvcreateexample.yaml--projects"A1,A2"cvcreateexample.yaml--publications"P1,P2"The projects/publications will be added in selected order.
Alternatively, use a colon:to include all entries.cvcreateexample.yaml--publications:NoteYou will need to add flags to include projects and publications.
If omitted none will be include.Custom logoThere are currently two components that are Expert Analytic:The logo image in the upper right corner of the first document.The footer image on each page.These two elements can be overridden through the.tomlcontent file.
Add the following two lines to the top of the file (outside a title scope):logo_image="path/to/image.png"footer_image="path/to/image.png"These can be any images, but it perhaps makes sense that thelogo_imageis
a personal photo when using the tool privately.Technology skillsTo be able to do statistics on various skills, the list of allowed skills is
limited to a predefined list. To quickly list what skills are allowed, and
their spelling, see:cv skillsIn addition, some skills have badges that can be activated during document
creation using the--badgesflag with e.g.cv createandcv latex.
To list which skill can produce an icon, see:cv skills --badgesAdding new skills and badgesIf a skill is missing, or a skill is written in an incorrect way, please eitherfile an issueormake a requestwith
the proposed change. In the latter case, the changes can be made to the file:cvcreator/templates/tech_skills.toml.In addition, if there is a badge that is missing (or needs replacing) here is
useful checklist:Find a badge candidate, consisting of simple pure black vector graphics
formatted as a.pdffile. Be wary that some tools will convert vector
graphics to raster when coverting.There should not be any copyright issues with the badge. Most badges are
currentlyCC0.Place the badge in the foldercvcreator/icons.Except for the.pdfextension, the name must exactly match that of the
badge trigger. This means include capitalized letters and spaces.Developer GuideThe project usespoetryto manage its development installation. Assumingpoetryinstalled on your system, installingcvcreatorfor development
can be done from the repository root with the command:poetryinstallThis will install all required dependencies and cvcreator into a virtual
environment. To enter the create environment, run:poetryshellAfterwards exit with:exitTestingTo ensure that the code run on your local system, run the following:poetryrunpytest--doctest-modulescvcreator/test/DeploymentReleases to PyPI (the repository used when usingpip install) is created
and deployed automatically when making a tagged released. To do so you need to:Update and push a new version number inpyproject.tomlto branchmaster.After merging to master, the workflow creates the tag and Github release for
this version and uploads its wheel file to Pypi.