Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 123 lines (86 sloc) 3.437 kb
37fcd90 Add simple documentation
Alessandro Strada authored
1 Google APIs Client library for OCaml
2 ====================================
3
390609b @astrada README minor changes
authored
4 **gapi-ocaml** is a simple, unofficial, OCaml client for Google Services. The
5 library supports ClientLogin, OAuth 1.0a, and OAuth 2.0 authentication.
6 Supported RESTful APIs:
37fcd90 Add simple documentation
Alessandro Strada authored
7
fbe30d7 @astrada Update README
authored
8 * Calendar APIs v3
fad6b1b @astrada Add Google+ data model test
authored
9 * Google+ API v1
9cbf3d6 @astrada Add tasks data model and tests
authored
10 * Tasks API v1
4b1ec25 @astrada Update README
authored
11 * APIs Discovery Service v1
12 * URL Shortener API v1
13 * OAuth2 API v2
10d616c @astrada Update README
authored
14 * Custom Search API v1
7f24b44 @astrada Update oasis file and README
authored
15 * Google Analytics API v3
38c47ed @astrada Update _oasis and READMEs
authored
16 * Page Speed Online API v1
3b3fcbf @astrada Update _oasis and READMEs (Blogger refs)
authored
17 * Blogger API v2
2d6fe5a @astrada Update _oasis and README
authored
18 * Site Verification API v1
0d48003 @astrada Update README and _oasis
authored
19 * AdSense Management API v1.1
634847c @astrada Update READMEs and oasis
authored
20 * BigQuery API v2
fad6b1b @astrada Add Google+ data model test
authored
21
fbe30d7 @astrada Update README
authored
22 Google Data Protocol APIs (GData):
1ff94b2 @astrada Fix bullet points in README
authored
23
ef73ad2 @astrada Update README (mention Google Drive)
authored
24 * Google Documents List API v3 (supports Google Drive)
37fcd90 Add simple documentation
Alessandro Strada authored
25
48203bf @astrada Update README
authored
26 ### Features
27
28 * Monadic interface
26272f9 @astrada Remove relative links from READMEs (#3)
authored
29 * [Functional lenses](http://astrada.github.com/gapi-ocaml/GapiLens.html) to
30 access data structures
4b1ec25 @astrada Update README
authored
31 * Service generator (experimental): a tool for generating client libraries for
ccefbc5 @astrada Update README, setup.ml and clean tree
authored
32 APIs based on the Google API Discovery format
37fcd90 Add simple documentation
Alessandro Strada authored
33
34 Building gapi-ocaml
35 ------------------
36
37 ### Requirements
38
9e3764c @astrada Update to release 0.1.9
authored
39 You will need the following libraries:
40
41 * [OCaml][] >= 3.12.0
42 * [Findlib][] >= 1.2.7
43 * [Ocamlnet][] >= 3.3.5
44 * [Ocurl][] >= 0.5.3
45 * [Cryptokit][] >= 1.3.14
46 * [ExtLib][] >= 1.5.1
47 * [json-wheel][] >= 1.0.6
48 * [Xmlm][] >= 1.0.2
49 * [pa_monad][] >= 6.0 (syntax extension for Monads, optional)
50 * [OUnit][] >= 1.1.0 (to build and run the tests, optional)
51
0dbfa09 @astrada Prepare for release 0.1.10
authored
52 This library was developed and tested on Ubuntu 12.04 LTS (64-bit).
37fcd90 Add simple documentation
Alessandro Strada authored
53
54 [OCaml]: http://caml.inria.fr/ocaml/release.en.html
55 [Findlib]: http://projects.camlcity.org/projects/findlib.html/
56 [Ocamlnet]: http://projects.camlcity.org/projects/ocamlnet.html
57 [Ocurl]: http://sourceforge.net/projects/ocurl/
58 [Cryptokit]: http://forge.ocamlcore.org/projects/cryptokit/
59 [ExtLib]: http://code.google.com/p/ocaml-extlib/
60 [json-wheel]: http://martin.jambon.free.fr/json-wheel.html
61 [Xmlm]: http://erratique.ch/software/xmlm/doc/Xmlm
62 [pa_monad]: http://www.cas.mcmaster.ca/~carette/pa_monad/
63 [OUnit]: http://ounit.forge.ocamlcore.org/
64
2032d6d @astrada Update documentation and authorization examples
authored
65 ### Configuration and installation
37fcd90 Add simple documentation
Alessandro Strada authored
66
2032d6d @astrada Update documentation and authorization examples
authored
67 This project provides 2 libraries:
37fcd90 Add simple documentation
Alessandro Strada authored
68
0dbfa09 @astrada Prepare for release 0.1.10
authored
69 * `gapi-ocaml`: Google APIs client library
70 * `gapi-ocaml.gdata`: Google Data Protocol client library
37fcd90 Add simple documentation
Alessandro Strada authored
71
435de32 @astrada Update README references to service generator
authored
72 To build the libraries, run
37fcd90 Add simple documentation
Alessandro Strada authored
73
2032d6d @astrada Update documentation and authorization examples
authored
74 $ ocaml setup.ml -configure
75 $ ocaml setup.ml -build
ccefbc5 @astrada Update README, setup.ml and clean tree
authored
76
435de32 @astrada Update README references to service generator
authored
77 To install the libraries, run (as root, if your user doesn't have enough
78 privileges)
ccefbc5 @astrada Update README, setup.ml and clean tree
authored
79
2032d6d @astrada Update documentation and authorization examples
authored
80 $ ocaml setup.ml -install
c1629e1 @astrada Add instructions to generate documentation
authored
81
73bcb52 @astrada Fix dependency on pa_monad
authored
82 To build and run the tests (you will need
83 [pa_monad](http://www.cas.mcmaster.ca/~carette/pa_monad/)), execute
c1629e1 @astrada Add instructions to generate documentation
authored
84
73bcb52 @astrada Fix dependency on pa_monad
authored
85 $ ocaml setup.ml -configure --enable-tests
86 $ ocaml setup.ml -build
2032d6d @astrada Update documentation and authorization examples
authored
87 $ ocaml setup.ml -test
88
26272f9 @astrada Remove relative links from READMEs (#3)
authored
89 See `src/test/README.md` for further details regarding the tests.
2032d6d @astrada Update documentation and authorization examples
authored
90
f478b72 @astrada Prepare for release 0.1.13
authored
91 To build the examples:
92
93 $ ocaml setup.ml -configure --enable-examples
94 $ ocaml setup.ml -build
95
96 See `examples/README.md` for further details regarding the examples.
97
2032d6d @astrada Update documentation and authorization examples
authored
98 To generate the documentation, run
99
100 $ ocaml setup.ml -doc
101
102 Then you can browse the HTML documentation starting from
103 `gapi-ocaml.docdir/index.html`, but is not installed by default.
104
105 To uninstall anything that was previously installed, execute
106
107 $ ocaml setup.ml -uninstall
c1629e1 @astrada Add instructions to generate documentation
authored
108
37fcd90 Add simple documentation
Alessandro Strada authored
109 ### Usage
110
26272f9 @astrada Remove relative links from READMEs (#3)
authored
111 See auth examples in `examples/auth` for some examples of how to use Google's
112 authorization endpoints.
37fcd90 Add simple documentation
Alessandro Strada authored
113
26272f9 @astrada Remove relative links from READMEs (#3)
authored
114 See `examples` directory to find code samples that show usage of some
115 services.
37fcd90 Add simple documentation
Alessandro Strada authored
116
7ef26ff @astrada Update README
authored
117 See `tools/serviceGenerator.ml` for a complex example of how to use functional
118 lenses within the state monad.
48203bf @astrada Update README
authored
119
26272f9 @astrada Remove relative links from READMEs (#3)
authored
120 See `tools/README.md` for the instructions of how to build and run the service
121 generator utility.
2032d6d @astrada Update documentation and authorization examples
authored
122
Something went wrong with that request. Please try again.