Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 85 lines (59 sloc) 2.29 kB
7cba1cc Prototype of CalendarList data structure
Alessandro Strada authored
1 Note: **Click on `README.md` in the directory view to have working relative
2 links.**
d854949 Fix README
Alessandro Strada authored
3
37fcd90 Add simple documentation
Alessandro Strada authored
4 Google APIs Client library for OCaml
5 ====================================
6
390609b @astrada README minor changes
authored
7 **gapi-ocaml** is a simple, unofficial, OCaml client for Google Services. The
8 library supports ClientLogin, OAuth 1.0a, and OAuth 2.0 authentication.
9 Supported RESTful APIs:
37fcd90 Add simple documentation
Alessandro Strada authored
10
48203bf @astrada Update README
authored
11 * Google Calendar APIs v3 (JSON based)
fad6b1b @astrada Add Google+ data model test
authored
12 * Google+ API v1
13
14 Old versions:
15 * Calendar Data API v2 (Atom based)
37fcd90 Add simple documentation
Alessandro Strada authored
16
48203bf @astrada Update README
authored
17 ### Features
18
19 * Monadic interface
4f53c81 @astrada Modify features section
authored
20 * Functional lenses to access data structures
37fcd90 Add simple documentation
Alessandro Strada authored
21
22 Building gapi-ocaml
23 ------------------
24
25 ### Requirements
26
27 This library was developed with the following dependencies (versions found in
28 Ubuntu 11.04):
29
30 * [OCaml][] = 3.11.2
31 * [Findlib][] = 1.2.5
32 * [Ocamlnet][] = 2.2.9
33 * [Ocurl][] = 0.5.3
34 * [Cryptokit][] = 1.3.14
35 * [ExtLib][] = 1.5.1
36 * [json-wheel][] = 1.0.6
37 * [Xmlm][] = 1.0.2
38 * [pa_monad][] = 6.0 Syntax extension for Monads (optional)
39 * [OUnit][] = 1.0.3 to build and run the tests (optional)
40
41 [OCaml]: http://caml.inria.fr/ocaml/release.en.html
42 [Findlib]: http://projects.camlcity.org/projects/findlib.html/
43 [Ocamlnet]: http://projects.camlcity.org/projects/ocamlnet.html
44 [Ocurl]: http://sourceforge.net/projects/ocurl/
45 [Cryptokit]: http://forge.ocamlcore.org/projects/cryptokit/
46 [ExtLib]: http://code.google.com/p/ocaml-extlib/
47 [json-wheel]: http://martin.jambon.free.fr/json-wheel.html
48 [Xmlm]: http://erratique.ch/software/xmlm/doc/Xmlm
49 [pa_monad]: http://www.cas.mcmaster.ca/~carette/pa_monad/
50 [OUnit]: http://ounit.forge.ocamlcore.org/
51
52 ### Building
53
54 To build the library, execute
55
56 $ cd src
57 $ ocamlbuild gdata/gdata.cma
58
59 To build the tests, execute
60
61 $ cd src
62 $ ocamlbuild test/testSuite.byte
63
64 To run the tests, see [tests README](src/test/README.md).
65
c1629e1 @astrada Add instructions to generate documentation
authored
66 To generate the documentation, execute
67
68 $ cd src
69 $ ocamlbuild gapi/gapi.docdir/index.html
70
71 Then you can access the HTML documentation starting from
72 `src/gapi.docdir/index.html`.
73
37fcd90 Add simple documentation
Alessandro Strada authored
74 ### Usage
75
f741ddf README Wording
Alessandro Strada authored
76 See [auth examples](src/examples/auth) for some examples of how to use
77 Google's authorization endpoints.
37fcd90 Add simple documentation
Alessandro Strada authored
78
f741ddf README Wording
Alessandro Strada authored
79 See [monadic test](src/test/testMonadic.ml) for an example of how to use the
80 monadic interface.
37fcd90 Add simple documentation
Alessandro Strada authored
81
48203bf @astrada Update README
authored
82 See [calendar v3 test](src/test/testCalendarModelV3.ml) for an example of how
83 to use functional lenses to read and modify calendar data.
84
Something went wrong with that request. Please try again.