Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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