<commit_before># Codereport

Codereport was born from a bureaucratic need to generate a PDF document
of a Rails app source code.

It also outputs HTML.

See an example here: [myreport.pdf](http://f.cl.ly/items/0D3k2L3y433e0m2I2b3V/myreport.pdf)

## Installation

Even though this project has the structure of a gem and even a gemspec I
didn't want to release yet another gem. If you want it to be a gem open an
issue and let me know.

Just clone the repo or add it to your Gemfile and use it
programmatically (see cli.rb for an example).

## Dependencies

Codereport depends on [Pygments](http://pygments.org/docs/installation/).

## Usage

Clone the repo, run `bundle install` and use the executable like this:

```
bundle exec bin/codereport
```

Full usage info:

```
Usage:
  codereport generate --title=TITLE

Options:
  --title=TITLE
  [--paths=one two three]
                                # Default: ["."]
  [--output=OUTPUT]
                                # Default: output
  [--format=FORMAT]
                                # Default: pdf
  [--extensions=one two three]
```

A real world example:

```
bundle exec bin/codereport generate --title ISSIntegral --paths ./lib/codereport.rb ./lib/codereport/
--format html --extensions rb --output myreport
```

## Limitations

I only mapped a few extensions to Pygments' highlighters. See
language_detector.rb and open an issue if you want more extensions.

## TODO

* Write tests #facepalm

## Contributing

Fork the [Codereport repository on GitHub](https://github.com/mhfs/codereport)
and send a Pull Request.

## License

MIT License. Copyright 2012 <NAME>. http://mhfs.com.br
<commit_msg>removing name of real project<commit_after># Codereport

Codereport was born from a bureaucratic need to generate a PDF document
of a Rails app source code.

It also outputs HTML.

See an example here: [myreport.pdf](http://f.cl.ly/items/0D3k2L3y433e0m2I2b3V/myreport.pdf)

## Installation

Even though this project has the structure of a gem and even a gemspec I
didn't want to release yet another gem. If you want it to be a gem open an
issue and let me know.

Just clone the repo or add it to your Gemfile and use it
programmatically (see cli.rb for an example).

## Dependencies

Codereport depends on [Pygments](http://pygments.org/docs/installation/).

## Usage

Clone the repo, run `bundle install` and use the executable like this:

```
bundle exec bin/codereport
```

Full usage info:

```
Usage:
  codereport generate --title=TITLE

Options:
  --title=TITLE
  [--paths=one two three]
                                # Default: ["."]
  [--output=OUTPUT]
                                # Default: output
  [--format=FORMAT]
                                # Default: pdf
  [--extensions=one two three]
```

A real world example:

```
bundle exec bin/codereport generate --title Codereport --paths ./lib/codereport.rb ./lib/codereport/
--format html --extensions rb --output myreport
```

## Limitations

I only mapped a few extensions to Pygments' highlighters. See
language_detector.rb and open an issue if you want more extensions.

## TODO

* Write tests #facepalm

## Contributing

Fork the [Codereport repository on GitHub](https://github.com/mhfs/codereport)
and send a Pull Request.

## License

MIT License. Copyright 2012 <NAME>. http://mhfs.com.br

{'fraction_non_alphanumeric': 0.09822235613136487, 'fraction_numerical': 0.009038867128653209, 'mean_word_length': 3.004825090470446, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4952021', 'n_tokens_mistral': 1070, 'n_tokens_neox': 982, 'n_words': 388}