package tdmrep

All checked builds pass
  1. Overview
  2. Docs
OCaml combinators for the W3C TDM Reservation Protocol

Install 

dune-project
 Dependency

tangled.org Readme Changelog ISC License Edit opam file Versions (1)

Authors

  1. A
    Anil Madhavapeddy <anil@recoil.org>

Maintainers

  1. A
    Anil Madhavapeddy <anil@recoil.org>

Sources

tdmrep-1.0.tbz
md5=3edc29b3956f7a55dba7fe12b897c087
sha512=33dc369bd70b67168c21c228fdd046a062e22d7a5780610dc8ff849f305d4fcdfba2e2d3d64b23fcdc4be5856ec1e562749f8475c4bb9d1ec38482f4c6382a8f

Description

Tdmrep provides Jsont codecs and typed OCaml values for Text Data Mining reservation declarations, well-known rule files, HTTP and document metadata, and TDM policies.

Added to opam-repository:

README

tdmrep -- Text and Data Mining Reservation Protocol

tdmrep provides typed OCaml values and Jsont codecs for the W3C TDM Reservation Protocol final report of 10 May 2024.

It covers:

  • /.well-known/tdmrep.json rule files;
  • tdm-reservation and tdm-policy HTTP fields;
  • HTML, EPUB, and PDF metadata names and values;
  • machine-readable JSON-LD TDM policies;
  • priority-aware merging of declarations from different representations.

Example

open Tdmrep

let policy =
  Uri.of_string "https://provider.example/policies/1"

let declaration =
  Declaration.make ~reservation:`Reserved ~policy ()

let response_fields = Http.encode declaration

let rules =
  Well_known.make
    [ Rule.make ~location:"/" ~reservation:`Reserved ~policy () ]

let json =
  Jsont_bytesrw.encode_string ~format:Jsont.Indent Well_known.jsont rules

Use Well_known.jsont and Policy.jsont with any Jsont backend, or embed it into your HTTP server for dynamic policies.

Dependencies (4)

  1. uri >= "4.4.0"
  2. jsont >= "0.2.0"
  3. ocaml >= "5.2"
  4. dune >= "3.23"

Dev Dependencies (3)

  1. odoc with-doc
  2. bytesrw with-test & >= "0.3.0"
  3. alcotest with-test & >= "1.9.0"

Optional Dependencies

None

Used by

None

Conflicts

None

Build status

Results of building tdmrep with each compiler on check.ci.ocaml.org, run of against opam-repository 7cdc698. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
1.0 (this version) n/a n/a good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure