daru-io 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1a45587a595f3d6c836314ef552e54fb51953ae
+  data.tar.gz: f71f9ba75000d5edfc249cbf83c04404bcf73b66
+SHA512:
+  metadata.gz: 3d73293b623a63bde856d5c791353da6501ffbfd0332ef4ffbf41cd92d2bce48376f86870b34b6d6dd175acfeb6bbdafc2130fc7db00dd7164b1fc6f14a5e816
+  data.tar.gz: 9b72a21fc1bf2622ccaeaed6c7f7e221934c04028e4b585447faeec578ad42a3c85f63bf380beb133d8e897485c5032a4887363e59fd55e14d8f83f112353ef8

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle/
+.yardoc/
+Gemfile.lock
+/_yardoc/
+*.DS_store
+.rspec_status
+coverage/
+dump.rdb
+doc/
+docs/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rspec_formatter.rb

@@ -0,0 +1,24 @@
+RSpec::Support.require_rspec_core 'formatters/base_text_formatter'
+
+class SimpleFormatter < RSpec::Core::Formatters::BaseTextFormatter
+  RSpec::Core::Formatters.register self,
+    :example_passed, :example_pending, :example_failed, :dump_pending, :dump_failures, :dump_summary
+
+  def example_passed(message); end
+
+  def example_pending(message); end
+
+  def example_failed(message); end
+
+  def dump_pending(message); end
+
+  def dump_failures(message); end
+
+  def dump_summary(message)
+    colorizer = ::RSpec::Core::Formatters::ConsoleCodes
+
+    output.puts "\nFinished in #{message.formatted_duration} " \
+       "(files took #{message.formatted_load_time} to load)\n" \
+       "#{message.colorized_totals_line(colorizer)}\n"
+  end
+end

data/.rubocop.yml

@@ -0,0 +1,109 @@
+require: rubocop-rspec
+
+AllCops:
+  Include:
+    - 'lib/**/*'
+  Exclude:
+    - 'vendor/**/*'
+    - 'benchmarks/*'
+    - 'profile/*'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.1
+
+# Preferred codebase style ---------------------------------------------
+
+### Layouts ------------------------------------------------------------
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+
+Layout/SpaceAfterComma:
+  Enabled: false
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+### Styles -------------------------------------------------------------
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+Style/EmptyMethod:
+  EnforcedStyle: compact
+
+Style/FileName:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false # TODO
+
+### Metrics ------------------------------------------------------------
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ModuleLength:
+  Max: 200
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 10
+
+### RSpec --------------------------------------------------------------
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/NestedGroups:
+  Max: 5

data/.travis.yml

@@ -0,0 +1,30 @@
+language:
+  ruby
+
+rvm:
+  - '2.1'
+  - '2.2'
+  - '2.3.0'
+  - '2.4.0'
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+
+services:
+  - redis-server
+  - mongodb
+
+before_install:
+  - redis-server --daemonize yes
+
+install:
+  - gem install bundler
+  - gem install rainbow -v '2.2.1'
+  - sudo apt-get update -qq
+  - sudo apt-get install -y libgsl0-dev r-base r-base-dev
+  - sudo Rscript -e "install.packages(c('Rserve','irr'),,'http://cran.us.r-project.org')"
+  - R CMD Rserve
+  - export R_HOME=/usr/lib/R
+  - gem install rsruby -- --with-R-dir=$R_HOME --with-R-include=/usr/share/R/include --with_cflags="-fPIC -g -O2 -fstack-protector --param=ssp-buffer-size=4 -Wformat -Wall -fno-strict-aliasing"
+  - bundle install

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--markup-provider redcarpet

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at athityakumar@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contribution guidelines
+
+First of all, thanks for thinking of contributing to this project. :smile:
+
+Before sending a Pull Request, please make sure that you're assigned the task on a GitHub issue.
+
+- If a relevant issue already exists, discuss on the issue and get it assigned to yourself on GitHub.
+- If no relevant issue exists, open a new issue and get it assigned to yourself on GitHub.
+
+Please proceed with a Pull Request only after you're assigned. It'd be sad if your Pull Request (and your hardwork) isn't accepted just because it isn't idealogically compatible.
+
+# Developing the gem
+
+1. Install required dependencies.
+
+    - For the Mongo Importer, install Mongo.
+    - For the RData Importer, RData Exporter, RDS Importer or RDS Exporter, install R and set the R_HOME
+      variable in your shell configuration:
+      ```sh
+      export R_HOME=/usr/lib/R # For Unix systems
+      export R_HOME=/usr/local/Frameworks/R.framework/Resources # For Mac systems 
+      ```
+    - For the Redis Importer, install Redis and start the redis server by typing `redis-server` in another
+      terminal window, before running the test suites.
+
+    For any issue(s) related to installation steps, kindly refer to the configurations mentioned in the
+    `.travis.yml` file.
+
+2. Clone this repository and install all the required gem dependencies.
+
+    ```sh
+    git clone https://github.com/athityakumar/daru-io.git
+    cd daru-io
+    gem install bundler
+    bundle install
+    ```
+
+3. Checkout to a different git branch (say, `adds-format-importer`).
+
+4. Add any gem dependencies required for the Format Importer to the `:optional` group of the Gemfile.
+
+5. Add code and YARD documentation to `lib/daru/io/importers/format.rb`, consistent with other IO modules.
+
+6. Add tests to `spec/daru/io/importers/format_spec.rb`. Add any `.format` files required for importer in `spec/fixtures/format/` directory.
+
+7. Run the rspec test-suite.
+    ```sh
+    # Runs test suite for all Importers & Exporters
+    bundle exec rspec
+
+    # Runs test-suite only for the newly added Format Importer
+    bundle exec rspec spec/daru/io/importers/format_spec.rb
+    ```
+
+8. Run the rubocop for static code quality comments.
+
+    ```sh
+    # Runs rubocop test for all Importer & Exporters
+    bundle exec rubocop
+
+    # Runs rubocop test only for the newly added Format Importer
+    bundle exec rubocop lib/daru/io/importers/format.rb spec/daru/io/importers/format_spec.rb
+    ```
+
+9. Send a Pull Request back to this repository. :tada:

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+gemspec
+
+group :optional do
+  gem 'activerecord', '~> 4.0'
+  gem 'avro'
+  gem 'dbd-sqlite3'
+  gem 'dbi'
+  gem 'jsonpath'
+  gem 'mongo'
+  gem 'nokogiri'
+  gem 'redis'
+  gem 'roo', '~> 2.7.0'
+  gem 'rsruby'
+  gem 'snappy'
+  gem 'spreadsheet', '~> 1.1.1'
+  gem 'sqlite3'
+end
+
+gem 'saharspec', git: 'https://github.com/zverok/saharspec.git'

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/daru/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')   { 'spec' }
+end
+
+# TODO: Run Rubocop in the background

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 [Athitya Kumar](https://github.com/athityakumar/) and [Ruby Science Foundation](https://github.com/SciRuby/).
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,654 @@
+# Daru-IO
+
+[![Build Status](https://travis-ci.org/athityakumar/daru-io.svg?branch=master)](https://travis-ci.org/athityakumar/daru-io)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/athityakumar/daru-io/master/)
+[![Inline docs](http://inch-ci.org/github/athityakumar/daru-io.png)](http://inch-ci.org/github/athityakumar/daru-io)
+[![Code Climate](https://codeclimate.com/github/athityakumar/daru-io.png)](https://codeclimate.com/github/athityakumar/daru-io)
+[![Stories in Ready](https://badge.waffle.io/athityakumar/daru-io.png?label=ready&title=Ready)](https://waffle.io/athityakumar/daru-io?utm_source=badge)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+A Ruby plugin-gem to [daru gem](https://github.com/SciRuby/daru), that extends support for many Import and
+Export methods of **Daru::DataFrame**. This gem is intended to help Rubyists who are into Data Analysis or Web
+Development, by serving as a general purpose conversion library that takes input in one format (say, JSON) and
+converts it another format (say, Avro) while also making it incredibly easy to getting started on
+analyzing data with daru.
+
+While supporting various IO modules, daru-io also provides an easier way of adding more Importers / Exporters. **It's strongly recommended to have a look at ['Creating your own IO modules' section](#creating-your-own-io-modules), if you're interested in creating new Importers / Exporters.**
+
+# Table of contents
+
+- [Installation](#installation)
+- *[Importers](#importers): [ActiveRecord](#activerecord-importer), [Avro](#avro-importer), [CSV](#csv-importer), [Excel](#excel-importer), [Excelx](#excelx-importer), [HTML](#html-importer), [JSON](#json-importer), [Mongo](#mongo-importer), [Plaintext](#plaintext-importer), [RData](#rdata-importer), [RDS](#rds-importer), [Redis](#redis-importer), [SQL](#sql-importer)*
+- *[Exporters](#exporters): [Avro](#avro-exporter), [CSV](#csv-exporter), [Excel](#excel-exporter), [JSON](#json-exporter), [RData](#rdata-exporter), [RDS](#rds-exporter), [SQL](#sql-exporter)*
+- [Creating your own IO modules](#creating-your-own-io-modules)
+- [Contributing](#contributing)
+- [License](#license)
+
+# Installation
+
+[(Go to Table of Contents)](#table-of-contents)
+
+- If you're working with a Gemfile,
+
+    - Add this line to your application's Gemfile:
+
+        ```ruby
+        gem 'daru-io'
+        ```
+
+    - And then execute on your terminal:
+
+        ```sh
+        bundle
+        ```
+
+- If you're NOT working with a Gemfile, simply install it yourself by executing on your terminal:
+
+    ```sh
+    gem install daru-io
+    ```
+
+- Require `daru-io` gem in your application:
+
+    ```ruby
+    require 'daru/io' #! Requires all Importers & Exporters
+    require 'daru/io/importers' #! Requires all Importers and no Exporters
+    require 'daru/io/importers/json' #! Requires only JSON Importer
+    ```
+
+**Note: Each IO module has it's own set of dependencies. Have a look at the [Importers](#importers) and [Exporters](#exporters) section for dependency-specific information.**
+
+# Importers
+
+The **Daru::IO** Importers are intended to return a **Daru::DataFrame** from the given arguments. Generally,
+all Importers can be called in two ways - from **Daru::IO** or **Daru::DataFrame**.
+
+```ruby
+#! Partially requires Format Importer
+require 'daru/io/importers/format'
+
+#! Usage from Daru::IO
+instance = Daru::IO::Importers::Format.from(connection)
+# or,
+instance = Daru::IO::Importers::Format.read(path)
+df = instance.call(opts)
+
+#! Usage from Daru::DataFrame
+df1 = Daru::DataFrame.from_format(connection, opts)
+df2 = Daru::DataFrame.read_format(path, opts)
+```
+
+**Note: Please have a look at the respective Importer Doc links below, for having a look at arguments and examples.**
+
+### ActiveRecord Importer
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Imports a **Daru::DataFrame** from an **ActiveRecord** connection.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Importers/ActiveRecord)
+- **Gem Dependencies**: `activerecord` gem
+- **Other Dependencies**: Install database server(s) such as SQL / Postgresql / etc.
+- **Usage**:
+    ```ruby
+    #! Partially require just ActiveRecord Importer
+    require 'daru/io/importers/active_record'
+
+    #! Usage from Daru::IO
+    df = Daru::IO::Importers::ActiveRecord.from(activerecord_relation).call(:field_1, :field_2)
+
+    #! Usage from Daru::DataFrame
+    df = Daru::DataFrame.from_activerecord(activerecord_relation, :field_1, :field_2)
+    ```
+
+### Avro Importer
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Imports a **Daru::DataFrame** from an **.avro** file.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Importers/Avro)
+- **Gem Dependencies**: `avro` and `snappy` gems
+- **Usage**:
+    ```ruby
+    #! Partially require just Avro Importer
+    require 'daru/io/importers/avro'
+
+    #! Usage from Daru::IO
+    df = Daru::IO::Importers::Avro.read('path/to/file.avro').call
+
+    #! Usage from Daru::DataFrame
+    df = Daru::DataFrame.read_avro('path/to/file.avro')
+    ```
+
+### CSV Importer
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Imports a **Daru::DataFrame** from a **.csv** or **.csv.gz** file.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Importers/CSV)
+- **Usage**:
+    ```ruby
+    #! Partially require just CSV Importer
+    require 'daru/io/importers/csv'
+
+    #! Usage from Daru::IO
+    df1 = Daru::IO::Importers::CSV.read('path/to/file.csv').call(skiprows: 10, col_sep: ' ')
+    df2 = Daru::IO::Importers::CSV.read('path/to/file.csv.gz').call(skiprows: 10, compression: :gzip)
+
+    #! Usage from Daru::DataFrame
+    df1 = Daru::DataFrame.read_csv('path/to/file.csv', skiprows: 10, col_sep: ' ')
+    df2 = Daru::DataFrame.read_csv('path/to/file.csv.gz', skiprows: 10, compression: :gzip)
+    ```
+
+### Excel Importer
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Imports a **Daru::DataFrame** from a **.xls** file.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Importers/Excel)
+- **Gem Dependencies**: `spreadsheet` gem
+- **Usage**:
+    ```ruby
+    #! Partially require just Excel Importer
+    require 'daru/io/importers/excel'
+
+    #! Usage from Daru::IO
+    df = Daru::IO::Importers::Excel.read('path/to/file.xls').call(worksheet_id: 1)
+
+    #! Usage from Daru::DataFrame
+    df = Daru::DataFrame.read_excel('path/to/file.xls', worksheet_id: 1)
+    ```
+
+### Excelx Importer
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Imports a **Daru::DataFrame** from a **.xlsx** file.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Importers/Excelx)
+- **Gem Dependencies**: `roo` gem
+- **Usage**:
+    ```ruby
+    #! Partially require just Excel Importer
+    require 'daru/io/importers/excelx'
+
+    #! Usage from Daru::IO
+    df = Daru::IO::Importers::Excelx.read('path/to/file.xlsx').call(sheet: 2, skiprows: 10, skipcols: 2)
+
+    #! Usage from Daru::DataFrame
+    require 'daru/io/importers/excel'
+    df = Daru::DataFrame.read_excel('path/to/file.xlsx', sheet: 2, skiprows: 10, skipcols: 2)
+    ```
+
+### HTML Importer
+
+[(Go to Table of Contents)](#table-of-contents)
+
+**Note: This module works only for static tables on a HTML page, and won't work in cases where the table is being loaded into the HTML table by inline Javascript. This is how the Nokogiri gem works, and the HTML Importer also follows suit.**
+
+Imports an **Array** of **Daru::DataFrame**s from a **.html** file or website.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Importers/HTML)
+- **Gem Dependencies**: `nokogiri` gem
+- **Usage**:
+    ```ruby
+    #! Partially require just HTML Importer
+    require 'daru/io/importers/html'
+
+    #! Usage from Daru::IO
+    df1 = Daru::IO::Importers::HTML.read('https://some/url/with/tables').call(match: 'market', name: 'Shares analysis')
+    df2 = Daru::IO::Importers::HTML.read('path/to/file.html').call(match: 'market', name: 'Shares analysis')
+
+    #! Usage from Daru::DataFrame
+    df1 = Daru::DataFrame.read_html('https://some/url/with/tables', match: 'market', name: 'Shares analysis')
+    df2 = Daru::DataFrame.read_html('path/to/file.html', match: 'market', name: 'Shares analysis')
+    ```
+
+### JSON Importer
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Imports a **Daru::DataFrame** from a **.json** file / response.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Importers/JSON)
+- **Gem Dependencies**: `jsonpath` gem
+- **Usage**:
+    ```ruby
+    #! Partially require just JSON Importer
+    require 'daru/io/importers/json'
+
+    #! Usage from Daru::IO
+    df1 = Daru::IO::Importers::JSON.read('https://path/to/json/response').call(index: '$..time', col1: '$..name', col2: '$..age')
+    df2 = Daru::IO::Importers::JSON.read('path/to/file.json').call(index: '$..time', col1: '$..name', col2: '$..age')
+
+    #! Usage from Daru::DataFrame
+    df1 = Daru::DataFrame.read_json('https://path/to/json/response', index: '$..time', col1: '$..name', col2: '$..age')
+    df2 = Daru::DataFrame.read_json('path/to/file.json', index: '$..time', col1: '$..name', col2: '$..age')
+    ```
+
+### Mongo Importer
+
+[(Go to Table of Contents)](#table-of-contents)
+
+**Note: The Mongo gem faces Argument Error : expected Proc Argument issue due to the bug in MRI Ruby 2.4.0 mentioned [here](https://bugs.ruby-lang.org/issues/13107). This seems to have been fixed in Ruby 2.4.1 onwards. Hence, please avoid using this Mongo Importer in Ruby version 2.4.0.**
+
+Imports a **Daru::DataFrame** from a Mongo collection.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Importers/Mongo)
+- **Gem Dependencies**: `jsonpath` and `mongo` gems
+- **Other Dependencies**: Install MongoDB
+- **Usage**:
+    ```ruby
+    #! Partially require just Mongo Importer
+    require 'daru/io/importers/mongo'
+
+    #! Usage from Daru::IO
+    df = Daru::IO::Importers::Mongo.from('mongodb://127.0.0.1:27017/test').call('cars')
+
+    #! Usage from Daru::DataFrame
+    df = Daru::DataFrame.from_mongo('mongodb://127.0.0.1:27017/test', 'cars')
+    ```
+
+### Plaintext Importer
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Imports a **Daru::DataFrame** from a **.dat** plaintext file (space separated table of simple strings and numbers). For a sample format of the plaintext file, have a look at the example [bank2.dat](https://github.com/athityakumar/daru-io/blob/master/spec/fixtures/plaintext/bank2.dat) file.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Importers/Plaintext)
+- **Usage**:
+    ```ruby
+    #! Partially require just Plaintext Importer
+    require 'daru/io/importers/plaintext'
+
+    #! Usage from Daru::IO
+    df = Daru::IO::Importers::Plaintext.read('path/to/file.dat').call([:col1, :col2, :col3])
+
+    #! Usage from Daru::DataFrame
+    df = Daru::DataFrame.read_plaintext('path/to/file.dat', [:col1, :col2, :col3])
+    ```
+
+### RData Importer
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Imports a **Daru::DataFrame** from a variable in **.rdata** file.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Importers/RData)
+- **Gem Dependencies**: `rsruby` gem
+- **Other Dependencies**: Install R and set `R_HOME` variable as given in the [Contribution Guidelines](CONTRIBUTING.md)
+- **Usage**:
+    ```ruby
+    #! Partially require just RData Importer
+    require 'daru/io/importers/r_data'
+
+    #! Usage from Daru::IO
+    df = Daru::IO::Importers::RData.read('path/to/file.RData').call('ACS3')
+
+    #! Usage from Daru::DataFrame
+    df = Daru::DataFrame.read_rdata('path/to/file.RData', 'ACS3')
+    ```
+
+### RDS Importer
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Imports a **Daru::DataFrame** from a **.rds** file.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Importers/RDS)
+- **Gem Dependencies**: `rsruby` gem
+- **Other Dependencies**: Install R and set `R_HOME` variable as given in the [Contribution Guidelines](CONTRIBUTING.md)
+- **Usage**:
+    ```ruby
+    #! Partially require just RDS Importer
+    require 'daru/io/importers/rds'
+
+    #! Usage from Daru::IO
+    df = Daru::IO::Importers::RDS.read('path/to/file.rds').call
+
+    #! Usage from Daru::DataFrame
+    df = Daru::DataFrame.read_rds('path/to/file.rds')
+    ```
+
+### Redis Importer
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Imports a **Daru::DataFrame** from **Redis** key(s).
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Importers/Redis)
+- **Gem Dependencies**: `redis` gem
+- **Other Dependencies**: Install Redis, and run an instance of `redis-server`
+- **Usage**:
+    ```ruby
+    #! Partially require just Redis Importer
+    require 'daru/io/importers/redis'
+
+    #! Usage from Daru::IO
+    df = Daru::IO::Importers::Redis.from({url: 'redis://:password@host:port/db'}).call(match: 'time:1*', count: 1000)
+
+    #! Usage from Daru::DataFrame
+    df = Daru::DataFrame.from_redis({url: 'redis://:password@host:port/db'}, match: 'time:1*', count: 1000)
+    ```
+
+### SQL Importer
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Imports a **Daru::DataFrame** from a **sqlite.db** file / **DBI** connection.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Importers/SQL)
+- **Gem Dependencies**: `dbd-sqlite3`, `activerecord`, `dbi` and `sqlite3` gems
+- **Usage**:
+    ```ruby
+    #! Partially require just SQL Importer
+    require 'daru/io/importers/sql'
+
+    #! Usage from Daru::IO
+    df1 = Daru::IO::Importers::SQL.read('path/to/file.sqlite').call('SELECT * FROM test')
+    df2 = Daru::IO::Importers::SQL.from(dbi_connection).call('SELECT * FROM test')
+
+    #! Usage from Daru::DataFrame
+    df1 = Daru::DataFrame.read_sql('path/to/file.sqlite', 'SELECT * FROM test')
+    df2 = Daru::DataFrame.from_sql(dbi_connection, 'SELECT * FROM test')
+    ```
+
+# Exporters
+
+The **Daru::IO** Exporters are intended to 'migrate' a **Daru::DataFrame** into a file, or database. All Exporters can be called in two ways - from **Daru::IO** or **Daru::DataFrame**.
+
+```ruby
+#! Partially requires Format Exporter
+require 'daru/io/exporters/format'
+
+#! Usage from Daru::IO
+instance = Daru::IO::Exporters::Format.new(df, opts)
+instance.to_s #=> Provides a file-writable string, which can be used in web applications for file download purposes
+instance.to #=> Provides a Format instance
+instance.write(path) #=> Writes to the given path
+
+#! Usage from Daru::DataFrame
+string = df.to_format_string(opts) #=> Provides a file-writable string, which can be to write into a file later
+instance = df.to_format(opts) #=> Provides a Format instance
+df.write_format(path, opts) #=> Writes to the given path
+```
+
+**Note: Please have a look at the respective Exporter Doc links below, for having a look at arguments and examples.**
+
+### Avro Exporter
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Exports a **Daru::DataFrame** into a **.avro** file.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Exporters/Avro)
+- **Gem Dependencies**: `avro` gem
+- **Usage**:
+    ```ruby
+    #! Partially require just Avro Exporter
+    require 'daru/io/exporters/avro'
+
+    avro_schema = {
+      'type' => 'record',
+      'name' => 'Example',
+      'fields' => [
+        {'name' => 'col_1', 'type' => 'string'},
+        {'name' => 'col_2', 'type' => 'int'},
+        {'name' => 'col_3', 'type'=> 'boolean'}
+      ]
+    }
+
+    #! Usage from Daru::IO
+    string = Daru::IO::Exporters::Avro.new(df, avro_schema).to_s
+    Daru::IO::Exporters::Avro.new(df, avro_schema).write('path/to/file.avro')
+
+    #! Usage from Daru::DataFrame
+    string = df.to_avro_string(avro_schema)
+    df.write_avro('path/to/file.avro', avro_schema)
+    ```
+
+### CSV Exporter
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Exports a **Daru::DataFrame** into a **.csv** or **.csv.gz** file.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Exporters/CSV)
+- **Usage**:
+    ```ruby
+    #! Partially require just CSV Exporter
+    require 'daru/io/exporters/csv'
+
+    #! Usage from Daru::IO
+    csv_string = Daru::IO::Exporters::CSV.new(df, converters: :numeric, convert_comma: true).to_s
+    Daru::IO::Exporters::CSV.new(df, converters: :numeric, convert_comma: true).write('path/to/file.csv')
+    csv_gz_string = Daru::IO::Exporters::CSV.new(df, converters: :numeric, compression: :gzip, convert_comma: true).to_s
+    Daru::IO::Exporters::CSV.new(df, converters: :numeric, compression: :gzip, convert_comma: true).write('path/to/file.csv.gz')
+
+    #! Usage from Daru::DataFrame
+    csv_string = df.to_csv_string(converters: :numeric, convert_comma: true)
+    df.write_csv('path/to/file.csv', converters: :numeric, convert_comma: true)
+    csv_gz_string = df.to_csv_string(converters: :numeric, compression: :gzip, convert_comma: true)
+    df.write_csv('path/to/file.csv.gz', converters: :numeric, compression: :gzip, convert_comma: true)
+    ```
+
+### Excel Exporter
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Exports a **Daru::DataFrame** into a **.xls** file.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Exporters/Excel)
+- **Gem Dependencies**: `spreadsheet` gem
+- **Usage**:
+    ```ruby
+    #! Partially require just Excel Exporter
+    require 'daru/io/exporters/excel'
+
+    #! Usage from Daru::IO
+    string = Daru::IO::Exporters::Excel.new(df, header: {color: :red, weight: :bold}, data: {color: :blue }, index: false).to_s
+    Daru::IO::Exporters::Excel.new(df, header: {color: :red, weight: :bold}, data: {color: :blue }, index: false).write('path/to/file.xls')
+
+    #! Usage from Daru::DataFrame
+    string = df.to_excel_string(header: {color: :red, weight: :bold}, data: {color: :blue }, index: false)
+    df.write_excel('path/to/file.xls', header: {color: :red, weight: :bold}, data: {color: :blue }, index: false)
+    ```
+
+### JSON Exporter
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Exports a **Daru::DataFrame** into a **.json** file.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Exporters/JSON)
+- **Gem Dependencies**: `jsonpath` gem
+- **Usage**:
+    ```ruby
+    #! Partially require just JSON Exporter
+    require 'daru/io/exporters/json'
+
+    #! Usage from Daru::IO
+    hashes = Daru::IO::Exporters::JSON.new(df, orient: :records, pretty: true, name: '$.person.name', age: '$.person.age').to
+    string = Daru::IO::Exporters::JSON.new(df, 'path/to/file.json', orient: :records, pretty: true, name: '$.person.name', age: '$.person.age').to_s
+    Daru::IO::Exporters::JSON.new(df, orient: :records, pretty: true, name: '$.person.name', age: '$.person.age').write('path/to/file.json')
+
+    #! Usage from Daru::DataFrame
+    hashes = df.to_json('orient: :records, pretty: true, name: '$.person.name', age: '$.person.age')
+    string = df.to_json_string(orient: :records, pretty: true, name: '$.person.name', age: '$.person.age')
+    df.write_json('path/to/file.json', orient: :records, pretty: true, name: '$.person.name', age: '$.person.age')
+    ```
+
+### RData Exporter
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Exports multiple **Daru::DataFrame**s into a **.rdata** file.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Exporters/RData)
+- **Gem Dependencies**: `rsruby` gem
+- **Other Dependencies**: Install R and set `R_HOME` variable as given in the [Contribution Guidelines](CONTRIBUTING.md)
+- **Usage**:
+    ```ruby
+    #! Partially require just RData Exporter
+    require 'daru/io/exporters/r_data'
+
+    #! Usage from Daru::IO
+    string = Daru::IO::Exporters::RData.new('first.df': df1, 'second.df': df2).to_s
+    Daru::IO::Exporters::RData.new('first.df': df1, 'second.df': df2).write('path/to/file.RData')
+    ```
+
+### RDS Exporter
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Exports a **Daru::DataFrame** into a **.rds** file.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Exporters/RDS)
+- **Gem Dependencies**: `rsruby` gem
+- **Other Dependencies**: Install R and set `R_HOME` variable as given in the [Contribution Guidelines](CONTRIBUTING.md)
+- **Usage**:
+    ```ruby
+    #! Partially require just RDS Exporter
+    require 'daru/io/exporters/rds'
+
+    #! Usage from Daru::IO
+    string = Daru::IO::Exporters::RDS.new(df, 'sample.dataframe').to_s
+    Daru::IO::Exporters::RDS.new(df, 'sample.dataframe').write('path/to/file.rds')
+
+    #! Usage from Daru::DataFrame
+    string = df.to_rds_string('sample.dataframe')
+    df.write_rds('path/to/file.rds', 'sample.dataframe')
+    ```
+
+### SQL Exporter
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Exports a **Daru::DataFrame** into a database (SQL) table through DBI connection.
+
+- **Docs**: [rubydoc.info](http://www.rubydoc.info/github/athityakumar/daru-io/master/Daru/IO/Exporters/SQL)
+- **Gem Dependencies**: `dbd-sqlite3`, `dbi` and `sqlite3` gems
+- **Other Dependencies**: Install SQL database server
+- **Usage**:
+    ```ruby
+    #! Partially require just SQL Exporter
+    require 'daru/io/exporters/sql'
+
+    #! Usage from Daru::IO
+    Daru::IO::Exporters::SQL.new(df, DBI.connect('DBI:Mysql:database:localhost', 'user', 'password'), 'cars_table').to
+
+    #! Usage from Daru::DataFrame
+    df.to_sql(DBI.connect('DBI:Mysql:database:localhost', 'user', 'password'), 'cars_table')
+    ```
+
+# Creating your own IO modules
+
+**Daru-IO** currently supports various Import / Export methods, as it can be seen from the above list. But the list is NEVER complete - there may always be specific use-case format(s) that you need very badly, but might not fit the needs of majority of the community. In such a case, don't worry - you can always tweak (aka monkey-patch) daru-io in your application. The architecture of `daru-io` provides a neater way of monkey-patching into **Daru::DataFrame** to support your unique use-case.
+
+ - **Adding new IO modules to Daru-IO**
+
+    Say, your unique use-case is of YAML IO Modules. Here's how you can proceed with tweaking -
+
+    ```ruby
+    #! YAML Importer
+
+    require 'daru/io'
+
+    class Daru::IO::Importers::YAML < Daru::IO::Importers::Base
+      Daru::DataFrame.register_io_module :from_yaml, self
+      Daru::DataFrame.register_io_module :read_yaml, self
+
+      def initialize
+        optional_gem 'yaml'
+        #! Add all required gem(s) here.
+      end
+
+      def from(instance)
+        #! Your code to create initialize instance
+        self
+      end
+
+      def read(path)
+        #! Your code to read the YAML file
+        #! and create Daru::DataFrame
+        self
+      end
+
+      def call(opts)
+        #! Unified code to create Daru::DataFrame
+        #! irrespective of which method
+        #! (from / read) is used by user
+      end
+    end
+
+    df = Daru::DataFrame.read_yaml('path/to/file.yaml', skip: 10)
+    # or,
+    df = Daru::IO::Importers::YAML.read('path/to/file.yaml').call(skip: 10)
+    ```
+
+    ```ruby
+    #! YAML Exporter
+
+    require 'daru/io'
+
+    class Daru::IO::Exporters::YAML < Daru::IO::Exporters::Base
+      Daru::DataFrame.register_io_module :to_yaml, self
+      Daru::DataFrame.register_io_module :to_yaml_string, self
+      Daru::DataFrame.register_io_module :write_yaml, self
+
+      def initialize(dataframe, opts)
+        super(dataframe) #! Have a look at documentation of Daru::IO::Exporters::Base#initialize
+        @opts = opts
+      end
+
+      def to
+        #! Your code to return a YAML instance
+      end
+
+      def to_s
+        super
+        #! By default, Exporters::Base adds this to_s method to all Exporters,
+        #! by making the write mthod to write to a tempfile, and then reading it.
+      end
+
+      def write(path)
+        #! Your code to write the YAML file
+        #! with the data in the @dataframe
+      end
+    end
+
+    df = Daru::DataFrame.new(x: [1,2], y: [3,4])
+
+    df.to_yaml(rows: 10..19) #! or, Daru::IO::Exporters::YAML.new(df, rows: 10..19).to
+    df.to_yaml_string(rows: 10..19) #! or, Daru::IO::Exporters::YAML.new(df, rows: 10..19).to_s
+    df.write_yaml('dataframe.yml', rows: 10..19) #! or, Daru::IO::Exporters::YAML.new(df, rows: 10..19).write('dataframe.yml')
+    ```
+
+- **Adding new IO modules to custom modules**
+
+    Behaviour of existing IO modules can also be reused according to your needs, similar to the above example. For example, if the CSV Importer has to be tweaked with a faster processing gem, simply follow an approach similar to this -
+
+    ```ruby
+    class CustomNamespace::Importers::CSV < Daru::IO::Importers::CSV
+      Daru::DataFrame.register_io_module :custom_csv, self
+
+      #! Your CSV Importer code here
+    end
+    ```
+
+**Note: The new module can be made to inherit from another module (like `Importers::JSON`) rather than `Importers::Base`, depending on use-case (say, parse a complexly nested API response with JsonPaths).**
+
+# Contributing
+
+[(Go to Table of Contents)](#table-of-contents)
+
+Contributions are always welcome. But, please have a look at the [contribution guidelines](CONTRIBUTING.md) first before contributing. :tada:
+
+# License
+
+[(Go to Table of Contents)](#table-of-contents)
+
+The MIT License (MIT) 2017 - [Athitya Kumar](https://github.com/athityakumar/) and [Ruby Science Foundation](https://github.com/SciRuby/). Please have a look at the [LICENSE.md](LICENSE.md) for more details.