Need help with yomu?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

466 Stars 107 Forks MIT License 98 Commits 27 Opened issues


Read text and metadata from files and documents (.doc, .docx, .pages, .odt, .rtf, .pdf)

Services available


Need anything else?

Contributors list

Travis Build Status Code Climate Score Gem Version

Yomu 読む


Yomu is a library for extracting text and metadata from files and documents using the Apache Tika content analysis toolkit.

Here are some of the formats supported:

  • Microsoft Office OLE 2 and Office Open XML Formats (.doc, .docx, .xls, .xlsx, .ppt, .pptx)
  • OpenDocument Formats (.odt, .ods, .odp)
  • Apple iWorks Formats
  • Rich Text Format (.rtf)
  • Portable Document Format (.pdf)

For the complete list of supported formats, please visit the Apache Tika Supported Document Formats page.


Text, metadata and MIME type information can be extracted by calling
require 'yomu'

data = 'sample.pages' text = :text, data metadata = :metadata, data mimetype = :mimetype, data

Reading text from a given filename

Create a new instance of Yomu and pass a filename.

yomu = 'sample.pages'
text = yomu.text

Reading text from a given URL

This is useful for reading remote files, like documents hosted on Amazon S3.

yomu = ''
text = yomu.text

Reading text from a stream

Yomu can also read from a stream or any object that responds to

, including file uploads from Ruby on Rails or Sinatra.
post '/:name/:filename' do
  yomu = params[:data][:tempfile]

Reading metadata

Metadata is returned as a hash.

yomu = 'sample.pages'
yomu.metadata['Content-Type'] #=> "application/"

Reading MIME types

MIME type is returned as a MIME::Type object.

yomu = 'sample.docx'
yomu.mimetype.content_type #=> "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
yomu.mimetype.extensions #=> ['docx']

Installation and Dependencies

Java Runtime

Yomu packages the Apache Tika application jar and requires a working JRE for it to work.


Add this line to your application's Gemfile:

gem 'yomu'

And then execute:

$ bundle

Or install it yourself as:

$ gem install yomu


  1. Fork it
  2. Create your feature branch (
    git checkout -b my-new-feature
  3. Create tests and make them pass (
    rake test
  4. Commit your changes (
    git commit -am 'Added some feature'
  5. Push to the branch (
    git push origin my-new-feature
  6. Create a new Pull Request

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.