CvBuilder

Build a beautiful CV PDF from a yaml text file.

Installation

The tool needs to have wkhtmltopdf installed on the machine to generate the PDF. See here on how to to install it.

🏗️ [Following is WIP]

Add this line to your application's Gemfile:

gem 'cv_builder'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install cv_builder

Usage

First we need to have a yaml file with the CV data. The yaml file supports following sections.

version: 1
profile:
  name: # Your name
  title: # Your current job title
  about: # Some basic details about your experience

contact:
  github: # Github username
  mobile: # Mobile number
  email: # email address
  linkedin: # Linkedin username
  location:
    country: # country name
    city: # city name

skills:
  - area: # specific skill area you are specialized in
    items:
      - # sub item such as a technology you have the skill in under the specialized area

experiences:
  - title: # job title
    organisation: # Name of the place you worked
    location:
      city: # city name
      country: # country name
    from:
      month: # month number that you started
      year: # year number that you started
  # if following is not given, it is assumed you are still working
    to:
      month: # month number that you stopped
      year: # year number that you stopped
    skills:
      - # a short name for a specialized skilled you gained
    achievements:
      - # Things you have achieved or did

education:
  - institute: # name of the place you studied
    location:
      city: # city name
      country: # country name
    qualification: # name of the degree/diploma qualification
    field: # name of the field such as Computer Science
    from:
      month: # month number that you started
      year: # year number that you started
    # if following is not given, it is assumed you are still studying
    to:
      month: # month number that you stopped
      year: # year number that you stopped
    achievements:
      - # Things you have achieved or did

See examples directory for samples.

Once you have the yml file, feed it into the bin/console and specify the output location.

bin/console -c examples/sinaru_resume.yml -o tmp/sinaru_resume.pdf

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. 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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sinaru/cv_builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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

Code of Conduct

Everyone interacting in the CvBuilder project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.