README.md

go-csvdict

Go package to implement a "dict reader" style CSV parser (on top of the default encoding/csv package) to return rows a key-value dictionaries rather than lists.

Documentation

Example

Reading files

import (
        "github.com/whosonfirst/go-csvdict"
	"os"
)

reader, reader_err := csvdict.NewReaderFromPath("example.csv")

// or maybe you might do
// reader, err := csvdict.NewReader(os.Stdin)

if err != nil {
	panic(err)
}

for {
	row, err := reader.Read()

	if err == io.EOF {
		break
	}

	if err != nil {
		return err
	}

	value, ok := row["some-key"]

	// and so on...
}

Writing files

import (
	"github.com/whosonfirst/go-csvdict"
	"os"
)

fieldnames := []string{"foo", "bar"}

writer, err := csvdict.NewWriter(os.Stdout, fieldnames)

// or maybe you might do
// writer, err := csvdict.NewWriterFromPath("new.csv", fieldnames)

if err != nil {
	panic(err)
}

writer.WriteHeader()

row := make(map[string]string)
row["foo"] = "hello"
row["bar"] = "world"

// See this? "baz" is not included in the list of fieldnames
// above so it will be silently ignored and excluded from your
// CSV file. Perhaps it should trigger an error. It doesn't, today...

row["baz"] = "wub wub wub"

writer.WriteRow(row)

See also

• https://golang.org/pkg/encoding/csv/
• https://docs.python.org/2/library/csv.html