<commit_before>![Rodolfo Logo](assets/rodolfo-logo.png)

[![Build Status](https://travis-ci.org/initios/rodolfo.svg?branch=master)](https://travis-ci.org/initios/rodolfo)
[![Code Climate](https://codeclimate.com/github/initios/rodolfo/badges/gpa.svg)](https://codeclimate.com/github/initios/rodolfo)
[![Gem Version](https://badge.fury.io/rb/rodolfo.svg)](https://badge.fury.io/rb/Rodolfo)
[![Test Coverage](https://codeclimate.com/github/initios/rodolfo/badges/coverage.svg)](https://codeclimate.com/github/initios/rodolfo/coverage)
[![Issue Count](https://codeclimate.com/github/initios/rodolfo/badges/issue_count.svg)](https://codeclimate.com/github/initios/rodolfo)

Rodolfo is a little binary to create pdfs with ease using the powerful Prawn library.
The main objective is to be able to use Rodolfo on any project / language as a tool
to create all of your pdf documents.

All you need to do is create a package folder with the following files:

  - schema.json – a json schema with the required fields, data-types, etc (optional)
  - template.rb – a ruby prawn template (see packages folder for examples)
  - data.json - as a valid data example and to test your template (optional)

Check the templates folder for examples.

By default prawn, prawn/table and prawn/measurements are loaded.

No advanced ruby skills are required.
Just follow the Prawn documentation and the example templates and you should be fine.

## Installation

```bash
gem install rodolfo
```

## Usage

```bash
cat packages/example/data.json | rodolfo render packages/example > output.pdf
```

Possible responses:<commit_msg>Improve README.md<commit_after>![Rodolfo Logo](assets/rodolfo-logo.png)

[![Build Status](https://travis-ci.org/initios/rodolfo.svg?branch=master)](https://travis-ci.org/initios/rodolfo)
[![Code Climate](https://codeclimate.com/github/initios/rodolfo/badges/gpa.svg)](https://codeclimate.com/github/initios/rodolfo)
[![Gem Version](https://badge.fury.io/rb/rodolfo.svg)](https://badge.fury.io/rb/Rodolfo)
[![Test Coverage](https://codeclimate.com/github/initios/rodolfo/badges/coverage.svg)](https://codeclimate.com/github/initios/rodolfo/coverage)
[![Issue Count](https://codeclimate.com/github/initios/rodolfo/badges/issue_count.svg)](https://codeclimate.com/github/initios/rodolfo)

Rodolfo is a little binary to create pdfs with ease using the powerful Prawn library.
The main objective is to be able to use Rodolfo on any project / language as a tool
to create all of your pdf documents.

All you need to do is create a package folder with the following files:

  - schema.json – a json schema with the required fields, data-types, etc (optional)
  - template.rb – a ruby prawn template (see packages folder for examples)
  - data.json - as a valid data example and to test your template (optional)

Check the templates folder for examples.

By default prawn, prawn/table and prawn/measurements are loaded.

No advanced ruby skills are required.
Just follow the Prawn documentation and the example templates and you should be fine.

## Installation

```bash
gem install rodolfo
```

## Quick Start

```
rodolfo g new-package "hello world package"
rodolfo render new-package --save-to hello.pdf
```

## Usage

```bash
cat packages/example/data.json | rodolfo render packages/example > output.pdf
```

Possible responses:
{'fraction_non_alphanumeric': 0.12109375, 'fraction_numerical': 0.0, 'mean_word_length': 4.789565217391305, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 20, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1902542', 'n_tokens_mistral': 1090, 'n_tokens_neox': 1047, 'n_words': 311}