Ruby Superparser

Ruby Superparser is a gem that simplifies making HTTP requests to the SuperParser API for parsing resume documents.

Add this line to your application's Gemfile:

gem 'ruby-superparser', git: 'https://github.com/jpsilvashy/ruby-superparser.git'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install ruby-superparser

1. Set the SUPERPARSER_API_KEY environment variable with your SuperParser API key:

export SUPERPARSER_API_KEY=your_api_key_here

To use this gem in a Rails application, run the generator to create an initializer:

rails generate superparser:install

This will create a config/initializers/superparser.rb file, which initializes the SUPERPARSER_CLIENT constant.

Now you can use the gem throughout your Rails application:

json_result = SUPERPARSER_CLIENT.parse_resume('path/to/your/resume.pdf')
puts json_result

In other Ruby applications, create a Client instance and use it to parse resumes:

require 'superparser'

api_key = ENV['SUPERPARSER_API_KEY']
client = Superparser::Client.new(api_key)
json_result = client.parse('path/to/your/resume.pdf')
puts json_result

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

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