Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/artonge/go-csv-tag
Read csv file from go using tags
https://github.com/artonge/go-csv-tag
csv go hacktoberfest tags
Last synced: 2 days ago
JSON representation
Read csv file from go using tags
- Host: GitHub
- URL: https://github.com/artonge/go-csv-tag
- Owner: artonge
- License: gpl-3.0
- Created: 2017-06-18T15:31:16.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T08:21:15.000Z (7 months ago)
- Last Synced: 2024-12-13T03:33:26.273Z (9 days ago)
- Topics: csv, go, hacktoberfest, tags
- Language: Go
- Homepage:
- Size: 63.5 KB
- Stars: 121
- Watchers: 3
- Forks: 33
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-go - go-csv-tag - Load csv file using tag. (File Handling / Search and Analytic Databases)
- awesome-go - go-csv-tag - Read csv file from go using tags - ★ 34 (Files)
- awesome-go-extra - go-csv-tag - 06-18T15:31:16Z|2021-11-14T17:04:52Z| (File Handling / Advanced Console UIs)
README
# go-csv-tag
Read csv file from Go using tags
[](http://godoc.org/github.com/artonge/go-csv-tag)
[](https://goreportcard.com/report/artonge/go-csv-tag)
[](http://makeapullrequest.com)
**The project is in maintenance mode.**
It is kept compatible with changes in the Go ecosystem but no new features will be developed. PR could be accepted.
# Install
`go get github.com/artonge/go-csv-tag/v2`
# Example
## Load
The csv file:
```csv
name, ID, number
name1, 1, 1.2
name2, 2, 2.3
name3, 3, 3.4
```
Your Go code:
```go
type Demo struct { // A structure with tags
Name string `csv:"name"`
ID int `csv:"ID"`
Num float64 `csv:"number"`
}
tab := []Demo{} // Create the slice where to put the content
err := csvtag.LoadFromPath(
"file.csv", // Path of the csv file
&tab, // A pointer to the create slice
csvtag.CsvOptions{ // Load your csv with optional options
Separator: ';', // changes the values separator, default to ','
Header: []string{"name", "ID", "number"}, // specify custom headers
TagKey: "csv", // specify a custom tag key, default to 'csv'
})
```
You can also load the data from an io.Reader with:
```go
csvtag.LoadFromReader(youReader, &tab)
```
Or from a string with:
```go
csvtag.LoadFromString(yourString, &tab)
```
## Dump
Your Go code:
```go
type Demo struct { // A structure with tags
Name string `csv:"name"`
ID int `csv:"ID"`
Num float64 `csv:"number"`
}
tab := []Demo{ // Create the slice where to put the content
Demo{
Name: "some name",
ID: 1,
Num: 42.5,
},
}
err := csvtag.DumpToFile(tab, "csv_file_name.csv")
```
You can also dump the data into an io.Writer with:
```go
err := csvtag.DumpToWriter(tab, yourIOWriter)
```
Or dump to a string with:
```go
str, err := csvtag.DumpToString(tab)
```
The csv file written:
```csv
name,ID,number
some name,1,42.5
```