Categorygithub.com/benpate/sherlock
repositorypackage
0.8.8
Repository: https://github.com/benpate/sherlock.git
Documentation: pkg.go.dev
Overview
Dependencies
38
Dependents
0

# README

Sherlock

Illustration of Sherlock Holmes and Watson in a train car, by Sidney Paget. From Arthur Conan Doyle's 1892 book 'The Adventure of Silver Blaze'

GoDoc Version Build Status Go Report Card Codecov

Relentless Metadata Inspector

Sherlock is a Go library that inspects a URL for any and all available metadata, pulling from whatever metadata formats are available, and returning it as an ActivityStreams 2.0 document.

The goal is to have a standard interface into all web content, regardless of competing data standards.

Supported Formats

āœ… ActivityPub/ActivityStreams

āœ… MicroFormats

āœ… Open Graph

In Progress

šŸš§ WebFinger

šŸš§ JSON-LD (Linked)

šŸš§ Twitter Metadata

šŸš§ Microdata

šŸš§ RDFa

šŸš§ oEmbed data provider

Using Sherlock

client := sherlock.NewClient()

// If you only have a URL, then pass it in to .Load()
result, err := client.Load("https://my-url-here")

// If you have already downloaded a file, then pass it to .Parse()
result, err := sherlock.ParseHTML("https://original-url", &bytes.Buffer)

Using Sherlock with Hannibal

Sherlock can also be used as an http client for Hannibal, the ActivityPub library for Go. This allows many other online resources to look like they're ActivityPub-enabled.