Bookaml is a library providing a basic API to gather information about a book given its ISBN, or to find any number of books matching given search criteria
OCaml Makefile
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples/ocsigen
src
.gitignore
.merlin
.ocp-indent
CHANGELOG
LICENSE
Makefile
README
_oasis
_tags
configure
myocamlbuild.ml
opam
setup.ml

README

=========================================================================
| README for Bookaml                                                    |
|                                                                       |
| http://bookaml.forge.ocamlcore.org/                                   |
|                                                                       |
| Dario Teixeira <dario.teixeira@nleyten.com>                           |
=========================================================================


1. Overview
===========

Bookaml is a library providing a basic API to gather information about a book
given its ISBN, or to find any number of books matching given search criteria.
It is closely tied to the Amazon Product Advertising API [1], which it uses
internally for retrieving book information.

Note that if you intend to use the library's facilities beyond basic validation
of ISBN numbers, you will need an Amazon Web Services account and associated
access keys.


2. Dependencies
===============

Bookaml depends on Batteries, Calendar, Cryptokit, and Ocamlnet's Netstring [2,3,4,5].
The optional auxiliary engines each have their own set of dependencies:

  * Bookaml_ocamlnet: Ocamlnet's Netclient and Tyxml [5,6].
  * Bookaml_ocsigen: Lwt, Ocsigenserver, and Tyxml [7,8,6].


3. Building and installing
==========================

The build system is generated with OASIS [9].  Run 'configure' if
you wish to modify the defaults.  Enter 'make' and 'make install'
to build and install the libraries.  Enter 'make doc' to generate
the API documentation.


4. License
==========

Bookaml is distributed under the terms of the GNU LGPL 2.1 with
OCaml linking exception.  See LICENSE file for full license text.


References
==========

[1] https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html
[2] https://batteries.forge.ocamlcore.org/
[3] https://calendar.forge.ocamlcore.org/
[4] https://forge.ocamlcore.org/projects/cryptokit/
[5] https://projects.camlcity.org/projects/ocamlnet.html
[6] https://www.ocsigen.org/tyxml
[7] https://www.ocsigen.org/lwt
[8] https://www.ocsigen.org/ocsigenserver
[9] https://oasis.forge.ocamlcore.org/