resme

This gem allows you to manage your resume in yaml, while providing different backends for publishings. Supported backends: markdown, json resume, and Europass XML. Custom templates can be defined using ERB.


License
MIT
Install
gem install resme -v 0.3.0

Documentation

RESME - A Resume Generator

Keep your resume in YAML and output it in various formats, including org-mode, markdown, json, and the Europass XML format.

The rendering engine is based on ERB. This simplifies the creation of new output formats (and extending/modifying the YML structure to one's needs).

Installation

Add this line to your application's Gemfile:

    gem 'resme'

And then execute:

$ bundle

Or install it yourself as:

$ gem install resme

Usage

Start with:

$ resme init

whih generates a YML template for your resume in the current directory. Comments in the YML file should help you fill the various entries. Notice that most entries are optional and you can remove sections which are not relevant for your resume.

You can then generate a resume using one of the existing templates or by writing your own template (see below).

To generate a resume in Markdown using the provided template:

$ resme org [-o output_filename] file.yml ...

To generate a resume in Markdown using the provided template:

$ resme md [-o output_filename] file.yml ...

To generate a resume in the Europass XML format using the provided template:

$ resme europass [-o output_filename] file.yml ...

To generate a resume in the JSON format (https://jsonresume.org/):

$ resme json [-o output_filename] file.yaml ...

Remarks:

  • you can specify more than one YML file in input. This allows you to store data about your resume in different files, if you like to do so (e.g., work experiences could be in one file and talks in another). The YML files are merged before processing them.
  • the output filename is optional. If you do not specify one, the resume is generated to resume-YYYY.MM.DD.format, where YYYY-MM-DD is today's date and format is the chosen output format

Checking validity

Use the check command to verify whether your YAML file conforms with the intended syntax.

resme check resume.yaml

Dates in the resume

Enter dates in the resume in one of the following formats:

  • Any format accepted by Ruby for a full date (year, month, day)
  • YYYY-MM-DD
  • YYYY-MM
  • YYYY

The third and the forth format allows you to enter "partial" dates (e.g., when the month or the day have been forgotten or are irrelevant).

Creating your own templates

The resumes are generated from the YML matter using ERB templates. The output formats should support different backends (OrgMode and Markdown easily allow for generation of PDFs, HTML, and ODT to mention a few).

You can define your own templates if you wish to do so.

All the data in the resume is made available in the data variable. Thus, for instance, the following code snippets generates a list of all the work experiences:

<% data.work each do |exp| %>
- <%= exp.who %>
  From: <%=  exp.from %> till: <%= exp.till %>
<% end %>

To specify your own ERB template use the option -t. Thus, for instance:

$ resme render -t template.md.erb [-o output_filename] file.yaml ...

uses template.md.erb to generate the resume.

Some functions can be used in the templates to better control the output.

String manipulation functions:

  • clean string removes any space at the beginning of string
  • reflow string, n makes string into an array of strings of length lower or equal to n (useful if you are outputting a textual format, for instance.

Dates manipulation functions:

  • period generates a string recapping a period. The function abstracts different syntax you can use for entries (i.e., date or from and till) and different values for the entries (e.g., a missing value for till)
  • year string, month string, day string return, respectively the year, month and day from strings in the format YYYY-MM-DDs
  • has_month input returns true if input has a month, that is, it is a date or it is in the form YYYY-MM
  • has_day input returns true if input has a day, that is, it is a date or it is in the form YYYY-MM-DD

You can find the templates in lib/resme/templates. These might be good starting points if you want to develop your own.

Contributing your templates

If you develop an output template and want to make it available, please let me know, so that I can include it in future releases of this gem.

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/avillafiorita/resme.

License

The gem is available as open source under the terms of the MIT License.

Roadmap

In doc/todo.org ... guess what is my preferred editor!

Bugs

There are still slight differences in the syntax of entries and in the way in which the information is formatted in various output formats. For instance, gender and birthdate are used in the Europass format, but not in the Markdown format. This is in part due to the different standards and in part due to personal preferences.

Entries are not sorted by date before outputting them. Make sure you put them in the order you want them to appear in your resume.

Unknown number of unknown bugs.

Release History

  • 0.3 introduces output to org-mode, introduces references for the CV, improves output to JSON, adds a check command, removes useless blank lines in the output, supports -%> in the ERB templates, fixes various typos in the documentation, introduces various new formatting functions, to simplify template generation
  • 0.2 improves output of volunteering activities and other information in the Europass and significantly improves error and warning reporting
  • 0.1 is the first release