|
| 1 | +# Tabular Data RDF Reader and JSON serializer |
| 2 | + |
| 3 | +[RDF-CSV][] reader for [RDF.rb][] and fully JSON serializer. |
| 4 | + |
| 5 | +[](http://badge.fury.io/rb/rdf-csv) |
| 6 | +[](http://travis-ci.org/ruby-rdf/rdf-csv) |
| 7 | + |
| 8 | +## Features |
| 9 | + |
| 10 | +RDF::CSV parses and serializes CSV or other Tabular Data into [RDF][] and JSON. |
| 11 | + |
| 12 | +Install with `gem install rdf-csv` |
| 13 | + |
| 14 | +## Examples |
| 15 | + |
| 16 | + require 'rubygems' |
| 17 | + require 'rdf/csv |
| 18 | + |
| 19 | +## RDF Reader |
| 20 | +{RDF::CSV} also acts as a normal RDF reader, using the standard RDF.rb Reader interface: |
| 21 | + |
| 22 | + graph = RDF::Graph.load("etc/doap.csv") |
| 23 | + |
| 24 | + |
| 25 | +## Documentation |
| 26 | +Full documentation available on [RubyDoc](http://rubydoc.info/gems/rdf-csv/file/README.md) |
| 27 | + |
| 28 | + |
| 29 | +### Principal Classes |
| 30 | +* {RDF::CSV} |
| 31 | + * {RDF::CSV::JSON} |
| 32 | + * {RDF::CSV::Format} |
| 33 | + * {RDF::CSV::Metadata} |
| 34 | + * {RDF::CSV::Reader} |
| 35 | + |
| 36 | +## Dependencies |
| 37 | +* [Ruby](http://ruby-lang.org/) (>= 1.9.2) |
| 38 | +* [RDF.rb](http://rubygems.org/gems/rdf) (>= 1.0) |
| 39 | +* [JSON](https://rubygems.org/gems/json) (>= 1.5) |
| 40 | + |
| 41 | +## Installation |
| 42 | +The recommended installation method is via [RubyGems](http://rubygems.org/). |
| 43 | +To install the latest official release of the `RDF::CSV` gem, do: |
| 44 | + |
| 45 | + % [sudo] gem install rdf-csv |
| 46 | + |
| 47 | +## Mailing List |
| 48 | +* <http://lists.w3.org/Archives/Public/public-rdf-ruby/> |
| 49 | + |
| 50 | +## Author |
| 51 | +* [Gregg Kellogg](http://github.com/gkellogg) - <http://greggkellogg.net/> |
| 52 | + |
| 53 | +## Contributing |
| 54 | +* Do your best to adhere to the existing coding conventions and idioms. |
| 55 | +* Don't use hard tabs, and don't leave trailing whitespace on any line. |
| 56 | +* Do document every method you add using [YARD][] annotations. Read the |
| 57 | + [tutorial][YARD-GS] or just look at the existing code for examples. |
| 58 | +* Don't touch the `json-ld.gemspec`, `VERSION` or `AUTHORS` files. If you need to |
| 59 | + change them, do so on your private branch only. |
| 60 | +* Do feel free to add yourself to the `CREDITS` file and the corresponding |
| 61 | + list in the the `README`. Alphabetical order applies. |
| 62 | +* Do note that in order for us to merge any non-trivial changes (as a rule |
| 63 | + of thumb, additions larger than about 15 lines of code), we need an |
| 64 | + explicit [public domain dedication][PDD] on record from you. |
| 65 | + |
| 66 | +License |
| 67 | +------- |
| 68 | + |
| 69 | +This is free and unencumbered public domain software. For more information, |
| 70 | +see <http://unlicense.org/> or the accompanying {file:UNLICENSE} file. |
| 71 | + |
| 72 | +[Ruby]: http://ruby-lang.org/ |
| 73 | +[RDF]: http://www.w3.org/RDF/ |
| 74 | +[YARD]: http://yardoc.org/ |
| 75 | +[YARD-GS]: http://rubydoc.info/docs/yard/file/docs/GettingStarted.md |
| 76 | +[PDD]: http://lists.w3.org/Archives/Public/public-rdf-ruby/2010May/0013.html |
| 77 | +[RDF.rb]: http://rubygems.org/gems/rdf |
0 commit comments