https://github.com/jnylen/xler
Excel Parser in Elixir using Rust
https://github.com/jnylen/xler
elixir excel parsing-library rust tuple worksheet
Last synced: 15 days ago
JSON representation
Excel Parser in Elixir using Rust
- Host: GitHub
- URL: https://github.com/jnylen/xler
- Owner: jnylen
- License: mit
- Created: 2019-04-11T21:44:34.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-26T04:56:55.000Z (over 2 years ago)
- Last Synced: 2025-10-19T15:39:58.345Z (4 months ago)
- Topics: elixir, excel, parsing-library, rust, tuple, worksheet
- Language: Elixir
- Homepage: https://github.com/jnylen/xler
- Size: 138 KB
- Stars: 6
- Watchers: 1
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://hex.pm/docs/publish), the package can be installed
by adding `xler` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:xler, "~> 0.6.0"}
]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/xler](https://hexdocs.pm/xler).
## Worksheets
To get the worksheets of a file you use:
```elixir
Xler.worksheets("filename.xls")
```
and it will return as a tuple:
```elixir
{:ok, ["Sheet 1"]}
```
## Parse
To get the data of a worksheet you use:
```elixir
Xler.parse("filename.xls", "Sheet 1")
```
and it will return as a tuple:
```elixir
{:ok, [["Date", "Time"]]}
```