Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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