xlsx is a library to simplify reading and writing the XML format used by recent version of Microsoft Excel in Go programs.
The support for writing XLSX files is currently extremely minimal. It will expand slowly, but in the meantime patches are welcome!
The full API docs can be viewed using go’s built in documentation tool, or online at godoc.org.
Here is a minimal example usage that will dump all cell data in a given XLSX file. A more complete example of this kind of functionality is contained in the XLSX2CSV program:
package main
import (
"fmt"
"github.com/tealeg/xlsx"
)
func main() {
excelFileName := "/home/tealeg/foo.xlsx"
xlFile, err := xlsx.OpenFile(excelFileName)
if err != nil {
...
}
for _, sheet := range xlFile.Sheets {
for _, row := range sheet.Rows {
for _, cell := range row.Cells {
text := cell.String()
fmt.Printf("%s\n", text)
}
}
}
}
Some additional information is available from the cell (for example, style information). For more details see the godoc output for this package.
The following constitutes the bare minimum required to write an XLSX document.
package main
import (
"fmt"
"github.com/tealeg/xlsx"
)
func main() {
var file *xlsx.File
var sheet *xlsx.Sheet
var row *xlsx.Row
var cell *xlsx.Cell
var err error
file = xlsx.NewFile()
sheet, err = file.AddSheet("Sheet1")
if err != nil {
fmt.Printf(err.Error())
}
row = sheet.AddRow()
cell = row.AddCell()
cell.Value = "I am a cell!"
err = file.Save("MyXLSXFile.xlsx")
if err != nil {
fmt.Printf(err.Error())
}
}
We’re extremely happy to review pull requests. Please be patient, maintaining XLSX doesn’t pay anyone’s salary (to my knowledge).
If you’d like to propose a change please ensure the following:
- All existing tests are passing.
- There are tests in the test suite that cover the changes you’re making.
- You have added documentation strings (in English) to (at least) the public functions you’ve added or modified.
- Your use of, or creation of, XML is compliant with part 1 of the 4th edition of the ECMA-376 Standard for Office Open XML.
Eat a peach - Geoff