package textrazor

All checked builds pass
  1. Overview
  2. Docs
An OCaml wrapper for the TextRazor API

Install

dune-project
 Dependency

Authors

Maintainers

Sources

textrazor-0.1.1.tbz
sha256=00c8c230c1327aa15005259e6b48b9a7e56401780cedfd1b8f8c432bd8fb8fda
sha512=46fe60e8dbb5cafe38b2e2adc8053e849a4feb3b9057388062bed04cfea61f42fd373abaeb503559fb2b5c924c10a91da3b22304f5b96d4808d5e1e776fd9483

Description

An OCaml wrapper for the TextRazor API

Added to opam-repository:

README

OCaml TextRazor  

An OCaml wrapper for the TextRazor API.

Installation

opam install textrazor

Usage

Configuration

open Textrazor

let client = Client.create "api_key"

(* Optional configuration *)
let client = Client.create ~use_eu_endpoint:false ~secure:true "api_key"

Analysis

Send either a text or a publicly available URL to the analysis endpoint.

open Textrazor

(* Analyze a text *)
let analysis = Analysis.post (`Text "Text to analyze") client

(* Analyze a text by public URL *)
let analysis =
  Analysis.post (`Uri (Uri.of_string "https://www.example.com/sample.txt")) c

Use Analysis.Options to customize the analysis.

open Textrazor

let analysis =
  let options = Analysis.Options.{default with field = value} in
  Analysis.post (`Text "Text to analyze") ~options client

Account

Get information about your Textrazor account.

open Textrazor

let account = Account.get client

Contributing

  • Fork the project;
  • Create your feature branch (git checkout -b my-new-feature);
  • Commit your changes (git commit -am 'Add some feature');
  • Push to the branch (git push origin my-new-feature);
  • Create a new pull request.

Dev Dependencies (2)

  1. odoc with-doc
  2. alcotest with-test

Optional Dependencies

None

Used by

None

Conflicts

None

Build status

Results of building textrazor with each compiler on check.ci.ocaml.org, run of against opam-repository 8a77e58. 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
0.1.1 (this version) good good 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