package equinoxe

  1. Overview
  2. Docs
An OCaml wrapper for the Equinix API

Install

Dune Dependency

Authors

Maintainers

Sources

equinoxe-0.1.0.tbz
sha256=b0cbec4d571ea94dc4c65c57a49a8387c2ec2b8f65e04a3fe52732f3d49b718c
sha512=1c648cf8d04e3993afacc5adf6dc30994893b6420622148b2c0cc1724300cbf3df6d9509bdaaa2346b971969290aed8bfbd779d213a15708c1019a45e5daac5e

Description

Equinoxe is an OCaml wrapper for the Equinix API.

Published: 08 Jan 2022

README

README.md

Equinoxe

An Equinix API client library for OCaml

About

Equinoxe is a library to interact with the Equinix API (formerly known as Packet) in OCaml. Users can use it to gather information, deploy machines or manage your organization within an OCaml program. It comes with a CLI, equinoxe-cli, that packs most of the functionalities of the API.

:warning: This repository is based on the official API but is not an official work from Equinix. This work is still in active development.

Getting started

Installation

To install the Equinoxe via opam:

$ opam install equinoxe

To install the dev version of Equinoxe, you have to install it via pinning:

$ opam pin add equinoxe.dev git@github.com:maiste/equinoxe
$ opam install equinoxe

Usage

The goal is to provide a minimal set of functions to interact with Equinix API:

Issues

Report issues using the GitHub bugtracker

License

This project is under the MIT License

Dependencies (6)

  1. lwt >= "5.3.0"
  2. http-lwt-client <= "0.0.8"
  3. cmdliner < "1.1.0"
  4. ezjsonm >= "1.3.0"
  5. ocaml >= "4.08.0"
  6. dune >= "2.9"

Dev Dependencies (4)

  1. httpaf-lwt-unix with-test
  2. alcotest-lwt with-test
  3. alcotest with-test
  4. odoc with-doc

Used by

None

Conflicts (1)

  1. result < "1.5"