Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 63 lines (44 sloc) 1.703 kB
37fcd90 Add simple documentation
Alessandro Strada authored
1 Google APIs Client library for OCaml
2 ====================================
3
4 ***gapi-ocaml*** is a simple, unofficial, OCaml client for Google Services.
5 The library supports ClientLogin, OAuth1.0a, and OAuth2.0 authentication.
6 Supported APIs:
7
8 * Calendar Data API
9
10
11 Building gapi-ocaml
12 ------------------
13
14 ### Requirements
15
16 This library was developed with the following dependencies (versions found in
17 Ubuntu 11.04):
18
19 * [OCaml][] = 3.11.2
20 * [Findlib][] = 1.2.5
21 * [Ocamlnet][] = 2.2.9
22 * [Ocurl][] = 0.5.3
23 * [Cryptokit][] = 1.3.14
24 * [ExtLib][] = 1.5.1
25 * [json-wheel][] = 1.0.6
26 * [Xmlm][] = 1.0.2
27 * [pa_monad][] = 6.0 Syntax extension for Monads (optional)
28 * [OUnit][] = 1.0.3 to build and run the tests (optional)
29
30 [OCaml]: http://caml.inria.fr/ocaml/release.en.html
31 [Findlib]: http://projects.camlcity.org/projects/findlib.html/
32 [Ocamlnet]: http://projects.camlcity.org/projects/ocamlnet.html
33 [Ocurl]: http://sourceforge.net/projects/ocurl/
34 [Cryptokit]: http://forge.ocamlcore.org/projects/cryptokit/
35 [ExtLib]: http://code.google.com/p/ocaml-extlib/
36 [json-wheel]: http://martin.jambon.free.fr/json-wheel.html
37 [Xmlm]: http://erratique.ch/software/xmlm/doc/Xmlm
38 [pa_monad]: http://www.cas.mcmaster.ca/~carette/pa_monad/
39 [OUnit]: http://ounit.forge.ocamlcore.org/
40
41 ### Building
42
43 To build the library, execute
44
45 $ cd src
46 $ ocamlbuild gdata/gdata.cma
47
48 To build the tests, execute
49
50 $ cd src
51 $ ocamlbuild test/testSuite.byte
52
53 To run the tests, see [tests README](src/test/README.md).
54
55 ### Usage
56
57 See [auth examples](src/examples/auth) to see how to use Google's OAuth 1.0
58 and OAuth 2.0 endpoints.
59
60 See [monadic test](src/test/testMonadic.ml) to see an example of how to use
61 the monadic interface.
62
Something went wrong with that request. Please try again.