Csv2schema

Automagically generate a JSON table schema file to go with a CSV file. Inspired by Stuart Lowe's JSON Table Schema Generator at ODI Leeds.

Installation

Add this line to your application's Gemfile:

gem 'csv2schema'

And then execute:

$ bundle

Or install it yourself as:

$ gem install csv2schema

Usage

You can either use the gem on the command line, or in your own Ruby code

On the command line

After installing the gem, you can generate a schema file on the command line like so:

csv2schema generate myfile.csv

This will generate a JSON table schema file at schema.json.

You can also specify a filename and extension like so:

csv2schema generate myfile.csv --filename=myschema.json

If you want to dump the JSON to the command line (to pipe somewhere else for example) we can handle that too:

csv2schema generate myfile.csv --dump

In your own Ruby code

Require the gem (if you haven't already):

require 'csv2schema'

Initialise the CSV with a file:

csv = Csv2schema::CSV.new(File.open("path/to/file.csv"))

Or with a URL:

csv = Csv2schema::CSV.new("http://example.org/file.csv")

Or with an IO-style object (i.e StringIO):

csv = Csv2schema::CSV.new(StringIO.new( my_data_in_a_string ))

Then get the schema as a JSON string:

csv.schema
#=> "{\"fields\":[{\"name\":\"Foo\",\"title\":\"Foo\",\"constraints\":{\"required\":false,\"type\":\"http://www.w3.org/2001/XMLSchema#int\"}},{\"name\":\"Bar\",\"title\":\"Bar\",\"constraints\":{\"required\":true,\"type\":\"http://www.w3.org/2001/XMLSchema#int\"}},{\"name\":\"Baz\",\"title\":\"Baz\",\"constraints\":{\"required\":true,\"type\":\"http://www.w3.org/2001/XMLSchema#int\"}}]}"

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/theodi/csv2schema. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.