Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jimm/csvlixir
A CSV reading/writing application for Elixir.
https://github.com/jimm/csvlixir
csv csv-data csv-export csv-import csv-parser csv-reading elixir
Last synced: 8 days ago
JSON representation
A CSV reading/writing application for Elixir.
- Host: GitHub
- URL: https://github.com/jimm/csvlixir
- Owner: jimm
- Created: 2013-11-26T21:19:27.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2020-06-12T17:39:17.000Z (over 4 years ago)
- Last Synced: 2024-10-11T14:09:26.345Z (28 days ago)
- Topics: csv, csv-data, csv-export, csv-import, csv-parser, csv-reading, elixir
- Language: Elixir
- Size: 26.4 KB
- Stars: 33
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - A CSV reading/writing application for Elixir. (CSV)
- fucking-awesome-elixir - csvlixir - A CSV reading/writing application for Elixir. (CSV)
- awesome-elixir - csvlixir - A CSV reading/writing application for Elixir. (CSV)
README
# CSVLixir
A CSV reader/writer for Elixir. Operates on files or strings.
## Installation
Add CSVLixir to your `mix.exs` dependencies:
```elixir
def deps do
[{:csvlixir, "~> 2.0.3"}]
end
```
Run `mix deps.get`. Done.
## Reading
### Files
To read CSV data from a file, use `CSVLixir.read`. It takes a path to a file
and returns a `Stream` that generates and returns rows of CSV data.
```elixir
CSVLixir.read("path/to/my.csv") |> Enum.to_list
#=> [["row", "one"], ["row", "two"]]
```
### Strings
Parsing CSV data from a string returns a list of lists. Use
`CSVLixir.parse`.
```elixir
CSVLixir.parse("abc,def,ghi\n123,456,789")
#=> [["abc","def","ghi"],["123","456","789"]]
CSVLixir.parse(~s{abc,def,"gh"",""i"})
#=> [["abc", "def", "gh\",\"i"]]
CSVLixir.parse(File.read!("/tmp/foo.csv"))
#=> [["row", "one"], ["row", "two"]]
```
## Writing
`CSVLixir.write` transforms a possibly lazy list of lists into a stream of
CSV strings. Each generated string ends with a newline.
```elixir
CSVLixir.write([["first", "row"], [123, 456]]) |> Enum.to_list
#=> ["first,row\n", "123,456\n"]
CSVLixir.write([["abc", "def", "gh\",\"i"], [123, 456, 789]])
|> Enum.each(&IO.write/1)
#=> abc,def,"gh"",""i"
#=> 123,456,789
#=> :ok
```
`CSVLixir.write_row` takes a single list and returns a single string.
```elixir
CSVLixir.write_row(["a", "b", "c"])
#=> "a,b,c\n"
```
### Writing to a file
Writing using streams:
```elixir
f = File.open!("/tmp/csvlixir.csv", [:write])
1..3
|> Stream.map(&([&1, &1+1 ,&1+2]))
|> CSVLixir.write
|> Stream.each(&(IO.write(f, &1)))
|> Stream.run
File.close(f)
File.read!("/tmp/csvlixir.csv")
# => "1,2,3\n2,3,4\n3,4,5\n"
```
Writing a line at a time:
```elixir
f = File.open!("/tmp/csvlixir.csv", [:write, :utf8])
IO.write(f, CSVLixir.write_row(["garçon", "waiter"]))
IO.write(f, CSVLixir.write_row(["résumé", "resume"]))
File.close(f)
File.read!("/tmp/csvlixir.csv")
# => "garçon,waiter\nrésumé,resume\n"
```
Don't forget to specify `:utf8` when opening the file for writing if needed.
(I often forget.)
# Changes from 1.0
Adds reading from/writing to files. Removes support for char lists.
# To Do
- Allow different separator characters besides comma.
- Handle headers. Return map instead of list, perhaps?