csv2json

package module
v0.0.0-...-a85992e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 28, 2023 License: MIT Imports: 10 Imported by: 0

README

csv2json Go Package

The csv2json Go package provides a convenient way to convert CSV data from various sources into JSON format. It supports conversion from file paths, URLs, and [][]string slices to JSON. The resulting JSON data can be either saved to a file or returned as a []map[string]interface{} slice.

Installation

To use the csv2json package in your Go project, you can install it using the following command:

go get github.com/informitas/csv2json

Usage

Import the csv2json package into your Go code and follow the usage instructions below.

import (
	"fmt"
	"github.com/informitas/csv2json"
)

func main() {
	csvConverter := csv2json.New()

	// Convert from a file path to JSON
	jsonData, err := csvConverter.Convert("input.csv", "output.json")
	if err != nil {
		fmt.Println("Error:", err)
		return
	}
	fmt.Println("JSON data:", jsonData)

	// Convert from a URL to JSON
	jsonData, err = csvConverter.Convert("https://example.com/data.csv", "output.json")
	if err != nil {
		fmt.Println("Error:", err)
		return
	}
	fmt.Println("JSON data:", jsonData)

	// Convert from [][]string to JSON
	csvData := [][]string{
		{"Name", "Age"},
		{"Alice", "25"},
		{"Bob", "30"},
	}
	jsonData, err = csvConverter.Convert(csvData, "")
	if err != nil {
		fmt.Println("Error:", err)
		return
	}
	fmt.Println("JSON data:", jsonData)
}

Methods

New

The New function initializes a new csv2json instance.

func New() *csv2json
Convert

The Convert method converts CSV data from various sources to JSON format.

func (c *csv2json) Convert(src interface{}, dest string) ([]map[string]interface{}, error)
  • src: The source data for conversion. It can be a file path, a URL, or a [][]string slice.
  • dest: The file path where the JSON data will be saved. If empty, the JSON data will be returned as a []map[string]interface{}.
Other Internal Methods
  • downloadFromURL(url string) ([][]string, error): Downloads CSV data from a URL and returns it as a [][]string.
  • transformToMap(src [][]string) ([]map[string]interface{}, error): Converts [][]string to []map[string]interface{}.
  • saveToFile(data []map[string]interface{}, dest string) error: Saves JSON data to a file.
  • arrayContentMatch(str string) (string, int): Checks if a string contains an array index and returns the modified string and the array index.

License

This project is licensed under the MIT License.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New() *csv2json

New initializes a new csv2json instance.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL