Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 2.52 KB

README.md

File metadata and controls

79 lines (52 loc) · 2.52 KB
Raw

CSV2API

Build Status Gem Version Dependency Status Code Climate security Inline docs Gitter chat

Auto-create json and xml APIs from csv files. Instant endpoints without any hassle.

Why should I use this?

  • Your boss/client hates you so they insist on sending you .csv files for their data.
  • You need to do a quick prototype and don't want to waste time importing / converting
  • You're bored and want to write an app with pre-historical data that you found on a floppy!
  • Your life depends on it (Disclaimer: Use at your own risk, jk you should be fine!)

Installation

Install it running:

$ gem install csv2api

Usage

Basic Example Code

To read from the current directory, run the following command

$ csv2api

Starting CSV2API...

2 csv files detected. Creating API endpoints...

tasks.csv - http://localhost:3000/tasks
weather.csv - http://localhost:3000/weather

Note: Endpoints can be accessed with the filename (spreadsheet view) or their .json, .xml extensions.

Spreadsheet View

csv2api_small

Load a specific folder

$csv2api -d office_stuff/sad_csvs/

Command-Line Application

Options:

  • -d, --directory - load csv files from directory
  • -v, --version - display the version
  • -h, --help - print help

TODO

Soon

  • Load single files
  • REST Support
  • WebUI

Author

Discussion

If you have any questions, ideas or a good joke:

Gitter chat

Contributing

Is it worth it? let me fork it

I put my thing down, flip it and debug it

Ti gubed dna ti pilf nwod gniht ym tup I

Ti gubed dna ti pilf nwod gniht ym tup I