File: README.md

package info (click to toggle)
ocaml-csv 2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 376 kB
  • sloc: ml: 2,101; makefile: 80
file content (55 lines) | stat: -rw-r--r-- 1,408 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
[![Build Status](https://travis-ci.org/Chris00/ocaml-csv.svg?branch=master)](https://travis-ci.org/Chris00/ocaml-csv)

OCaml CSV
=========

The [comma-separated values](http://en.wikipedia.org/wiki/Comma-separated_values)
format — or CSV for short — is a simple tabular format supported by
all major spreadsheets.  This library implements pure OCaml functions
to read and write files in this format (including Excel extensions) as
well as some convenience functions to manipulate such data.

Compile & install
-----------------

The easiest way to install this library is to use [OPAM][]:

    opam install csv

for the standard version and

    opam install csv-lwt

for the LWT one.  If you prefer to compile and install by hand,
make sure you have [dune][] and run

    dune build @install
    dune install csv
    dune install csv-lwt

[OPAM]: https://opam.ocaml.org/
[dune]: https://github.com/ocaml/dune


Uninstall
---------

With OPAM:

    opam remove csv
    opam remove csv-lwt

Manually (from the source directory):

    dune uninstall csv
    dune uninstall csv-lwt

Documentation
-------------

The documentation for the `Csv` (resp. `Csv_lwt`) module can be
found [online](https://math.umons.ac.be/anum/software/csv/) 
(resp. [here](https://math.umons.ac.be/anum/software/csv-lwt/)) or in
[csv.mli](src/csv.mli) (resp. [csv_lwt.mli](lwt/csv_lwt.mli)).

Also see the [examples](examples/).