Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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