Skip to content

Latest commit

 

History

History
111 lines (76 loc) · 3.12 KB

README.md

File metadata and controls

111 lines (76 loc) · 3.12 KB
Raw

Note: Click on README.md in the directory view to have working relative links.

Google APIs Client library for OCaml

gapi-ocaml is a simple, unofficial, OCaml client for Google Services. The library supports ClientLogin, OAuth 1.0a, and OAuth 2.0 authentication. Supported RESTful APIs:

  • Calendar APIs v3 (JSON based)
  • Google+ API v1
  • Tasks API v1
  • APIs Discovery Service v1
  • URL Shortener API v1
  • OAuth2 API v2

Old versions:

  • Calendar Data API v2 (Atom based)

Features

  • Monadic interface
  • Functional lenses to access data structures
  • Service generator (experimental): a tool for generating client libraries for APIs based on the Google API Discovery format

Building gapi-ocaml

Requirements

This library was developed with the following dependencies (Unofficial OCaml packages for Debian):

Configuration and installation

This project provides 2 libraries:

  • gapi: Google APIs client library
  • gdata: Google Data Protocol client library

and 1 executable:

  • serviceGenerator: Tool used to generate strongly typed client libraries for Discovery-based services

To build the libraries and the executable, run

$ ocaml setup.ml -configure
$ ocaml setup.ml -build

To install the libraries and the executable, run (as root, if your user doesn't have enough privileges)

$ ocaml setup.ml -install

To run the tests, execute

$ ocaml setup.ml -test

See tests README for further details regarding the tests.

To generate the documentation, run

$ ocaml setup.ml -doc

Then you can browse the HTML documentation starting from gapi-ocaml.docdir/index.html, but is not installed by default.

To uninstall anything that was previously installed, execute

$ ocaml setup.ml -uninstall

Usage

See auth examples for some examples of how to use Google's authorization endpoints.

See examples directory to find simple code samples that show usage of some services.

See service generator for a complex example of how to use functional lenses within the state monad.

See tools README for the instructions of how to run the service generator utility.