package socialpeek

  1. Overview
  2. No Docs
OCaml library to extract social information such as Twitter cards or OpenGraph data from webpages and HTML.

Install

Dune Dependency

Authors

Maintainers

Sources

1.0.0.tar.gz
sha256=db114639e8b6eefeb6285193681b705dfd498435fc92c2ec5473a2ebb9eb24af
md5=a0af71f8d0761d948d29052b68cf850b

Description

Usage

Get twitter card

open Socialpeek

let () =
  (** you can use `from_html` instead if you already have the HTML *)
  let twitter_card = from_url "http://something.cool" |> Twitter.get_card in
  match twitter_card with
  | Twitter.Summary data -> (** Do something with data *)
  | Twitter.Summary_large_image data -> (** Do something with data *)
  | Twitter.App data -> (** Do something with data *)
  | Twitter.Player data -> (** Do something with data *)

Twitter cards can have 4 different shapes: summary, summary_large_image, app or player (more info about twitter cards). So the result of Twitter.get_card is a variant type that holds only the data a certain type of card can have.

Get Opengraph data

open Socialpeek

let () =
  (** you can use `from_html` instead if you already have the HTML *)
  let og_data = from_url "http://something.cool" |> Opengraph.get_data in
  (** do something with the data *)

Get twitter and opengraph data

open Socialpeek

let () =
  (** you can use `from_html` instead if you already have the HTML *)
  let tags = from_url "http://something.cool" in
  let og_data = Opengraph.get_data tags in
  let twitter_card = Twitter.get_card tags in
  (** do something with the data *)

Published: 11 Jan 2018

Dependencies (6)

  1. jbuilder >= "1.0+beta10"
  2. cohttp-lwt-unix < "0.100.0"
  3. lwt_ssl < "1.2.0"
  4. lambdasoup < "0.7.0"
  5. base < "v0.14"
  6. ocaml >= "4.02.3"

Dev Dependencies (1)

  1. ounit with-test & >= "2.0.6"

Used by

None

Conflicts

None

OCaml

Innovation. Community. Security.