Instructor Tools: Common Tools

Welcome to the instructor tools Common Tools gem. This gem will exist as a dependency of Instructor-Tools.

The purpose of this gem is to provide instructors with a resource for commonly used tools (parsing a batch csv into student objects) that can be required as a dependency instead of re-writing the same code.

Instructions

To include this gem add the below line to your projects gemfile:

gem 'instructor-tools-common-tools'

Functionality

This gem contains several functions see below for specific details

  • CSV to JSON Parser
    • CommonTools.parse_csv('complete/path/to/file')
    • This will parse your csv file into a JSON string

Contributing

To contribute to this gem:

  • Fork the repo
  • Make your contributions and set up whatever tests are necessary
  • Wrap any new functionality in CommonTools class methods
  • Submit a pull request