https://github.com/chris00/ocaml-docker

Binding to the Docker Remote API
https://github.com/chris00/ocaml-docker

docker ocaml ocaml-client opam

Last synced: 15 days ago
JSON representation

Binding to the Docker Remote API

• Host: GitHub
• URL: https://github.com/chris00/ocaml-docker
• Owner: Chris00
• License: isc
• Created: 2014-11-24T09:03:28.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2022-05-31T14:36:35.000Z (over 2 years ago)
• Last Synced: 2024-05-09T23:22:36.064Z (6 months ago)
• Topics: docker, ocaml, ocaml-client, opam
• Language: OCaml
• Size: 164 KB
• Stars: 28
• Watchers: 8
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
OCaml client for Docker Remote API

==================================

This library provides an OCaml client for

[Docker Remote API](https://docs.docker.com/reference/api/docker_remote_api/),

version 1.29.

This library is tested with the

[community edition](https://docs.docker.com/engine/installation/)

of Docker.

Note that the OPAM and ocamlfind packages are called `docker-api` (to

distinguish them from other packages related to Docker) but the OCaml

module is named `Docker` (because the code reads better with that name

IMHO).

Compilation & installation

--------------------------

The easier way to install this library is to use

[OPAM](http://opam.ocaml.org/).  Just type:

    opam install docker-api

This library depends on [Dune](https://github.com/ocaml/dune) (to

compile) and [Yojson](https://github.com/ocaml-community/yojson).

To compile as a developer, just type `make` and then `make install` to

install it.

Documentation

-------------

Please read the [interface](src/docker.mli) or the

[HTML version](http://chris00.github.io/ocaml-docker/doc/docker-api/Docker/).

Testing

-------

If you compile using `make`, the tests will be built.  In order to run

them, make sure that the latest Debian image is installed — if not,

simply issue `docker pull debian:latest` in a shell — and issue `make

test`.