xler/README.md
2019-04-23 09:21:00 +02:00

972 B

Xler

Xler uses the Calamine Rust library to get contents of Excel files.

Calamine supports:

  • excel (xls, xlsx, xlsm, xlsb, xla, xlam)
  • opendocument spreadsheets (ods)

Installation

If available in Hex, the package can be installed by adding xler to your list of dependencies in mix.exs:

def deps do
  [
    {:xler, "~> 0.2.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/xler.

Worksheets

To get the worksheets of a file you use:

Xler.worksheets("filename.xls")

and it will return as a tuple:

{:ok, ["Sheet 1"]}

Parse

To get the data of a worksheet you use:

Xler.parse("filename.xls", "Sheet 1")

and it will return as a tuple:

{:ok, [["Date", "Time"]]}