opengraph

package module
v1.0.0-...-5a30d08 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 28, 2016 License: MIT Imports: 3 Imported by: 0

README

Open Graph protocol opengraph

opengraph is a Go library and command-line tool for extracting Open Graph metadata from HTML documents.

Documentation: http://godoc.org/github.com/rojters/opengraph
Open Graph protocol: http://ogp.me/
Build Status: travis-ci status Build Status

Usage

import "github.com/rojters/opengraph"

To extract Open Graph metadata from a movie on IMDb (sans error handling):

res, _ := http.Get("http://www.imdb.com/title/tt0118715/")
md, _ := opengraph.Extract(res.Body)
for i := range md {
	fmt.Printf("%s = %s\n", md[i].Property, md[i].Content)
}

Which will output:

url = http://www.imdb.com/title/tt0118715/
type = video.movie
title = The Big Lebowski (1998)
site_name = IMDb
description = Directed by Joel Coen, Ethan Coen.  With Jeff Bridges ...
...

License

MIT

Documentation

Overview

Package opengraph extracts Open Graph metadata from HTML documents. See http://ogp.me/ for more information about the Open Graph protocol.

Usage:

import "github.com/rojters/opengraph"

To extract Open Graph metadata from a movie on IMDb (sans error handling):

res, _ := http.Get("http://www.imdb.com/title/tt0118715/")
md, _ := opengraph.Extract(res.Body)
for i := range md {
	fmt.Printf("%s = %s\n", md[i].Property, md[i].Content)
}

Which will output:

url = http://www.imdb.com/title/tt0118715/
type = video.movie
title = The Big Lebowski (1998)
site_name = IMDb
description = Directed by Joel Coen, Ethan Coen.  With Jeff Bridges ...
...

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MetaData

type MetaData struct {
	Property string // Property attribute without prefix.
	Content  string // Content attribute. See http://ogp.me/#data_types for a list of content attribute types.
	Prefix   string
}

func Extract

func Extract(doc io.Reader) ([]MetaData, error)

Extract extracts Open Graph metadata from a HTML document. If no relevant metadata is found the result will be empty. The input is assumed to be UTF-8 encoded.

func ExtractPrefix

func ExtractPrefix(doc io.Reader, prefix string) ([]MetaData, error)

Same as Extract but extracts metadata with a specific prefix, e.g. "fb" for Facebook. If prefix is empty all matching metadata is extracted.

Directories

Path Synopsis
cmd
og

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL