Extracts OpenGraph, TwitterCard and Schema properties from a webpage.
Project description
[](https://travis-ci.org/ludbek/webpreview)
# About
Webpreview helps preview a webpage. It extracts [Open Graph](http://ogp.me/), [Twitter Card](https://dev.twitter.com/cards/overview) and [Schema](http://schema.org/) meta tags. Given a URL of a page, it extracts title, thumbnail, description, etc as per request.
#Installation
$ pip install webpreview
#Usage
## Preview a Web Page
API: `web_preview(url, timeout?, headers?, content?, absolute_image_url?, parser?)`
Use `web_preview` for extracting title, description and thumbnail image. It tries to extract them from Open Graph properties, if not found it falls back to Twitter Card, and so on till Schema. If non works it tries to extract from the webpage's content.
$ from webpreview import web_preview
$ title, description, image = web_preview("aurl.com")
# specifing timeout which gets passed to requests.get()
$ title, description, image = web_preview("a_slow_url.com", timeout=1000)
# passing headers
$ headers = {'User-Agent': 'Mozilla/5.0'}
$ title, description, image = web_preview("a_slow_url.com", headers=headers)
# pass html content thus avoiding making http call again to fetch content.
$ content = """<html><head><title>Dummy HTML</title></head></html>"""
$ title, description, image = web_preview("aurl.com", content=content)
# specifing the parser
# by default webpreview uses 'html.parser'
$ title, description, image = web_preview("aurl.com", content=content, parser='lxml')
## Open Graph
API: `OpenGraph(url, properties, timeout?, headers?, content?, parser?)`
`OpenGraph` extracts Open Graph meta properties. Consider following meta tags.
<!--doc snippet at aurl.com -->
<meta property="og:title" content="a title" />
<meta property="og:description" content="a description" />
<meta property="article:published_time" content="2013-09-17T05:59:00+01:00" />
<meta property="og:price:amount" content="15.00" />
Below is a snippet showing its usage.
$ from webpreview import OpenGraph
# pass a URL and a list of meta properties
$ og = OpenGraph("http://aurl.com", ["og:title", "article:published_time", "og:price:amount"])
# OpenGraph dynamically assigns corresponding properties to its instance. As you will see it excludes `og:` from the supplied properties.
$ og.title
=> "a title"
$ og.published_time
=> "2013-09-17T05:59:00+01:00"
# It converts `:` in a property into `_`.
$ og.price_amount
=> "15.00"
## Twitter Card
API: `TwitterCard(url, properties, timeout?, headers?, content?, parser?)`
`TwitterCard` extracts Twitter Card meta properties from the given webpage. Its usage is similar to `OpenGraph`.
$ from webpreview import TwitterCard
$ tc = TwitterCard("aurl.com", ["twitter:title", "twitter:image"])
$ tc.title
$ tc.image
## Schema
API: `Schema(url, properties, timeout?, headers?, content?, parser?)`
Webpreview supports Schema through the class `Schema`. Right now it extracts properties in meta tags only.
$ from webpreview import Schema
$ aschema = Schema("aurl.com", ["name", "camelCaseProperty"]
$ aschema.name
# It makes Camel Case properties available as Snake Case.
$ aschema.camel_case_property
# About
Webpreview helps preview a webpage. It extracts [Open Graph](http://ogp.me/), [Twitter Card](https://dev.twitter.com/cards/overview) and [Schema](http://schema.org/) meta tags. Given a URL of a page, it extracts title, thumbnail, description, etc as per request.
#Installation
$ pip install webpreview
#Usage
## Preview a Web Page
API: `web_preview(url, timeout?, headers?, content?, absolute_image_url?, parser?)`
Use `web_preview` for extracting title, description and thumbnail image. It tries to extract them from Open Graph properties, if not found it falls back to Twitter Card, and so on till Schema. If non works it tries to extract from the webpage's content.
$ from webpreview import web_preview
$ title, description, image = web_preview("aurl.com")
# specifing timeout which gets passed to requests.get()
$ title, description, image = web_preview("a_slow_url.com", timeout=1000)
# passing headers
$ headers = {'User-Agent': 'Mozilla/5.0'}
$ title, description, image = web_preview("a_slow_url.com", headers=headers)
# pass html content thus avoiding making http call again to fetch content.
$ content = """<html><head><title>Dummy HTML</title></head></html>"""
$ title, description, image = web_preview("aurl.com", content=content)
# specifing the parser
# by default webpreview uses 'html.parser'
$ title, description, image = web_preview("aurl.com", content=content, parser='lxml')
## Open Graph
API: `OpenGraph(url, properties, timeout?, headers?, content?, parser?)`
`OpenGraph` extracts Open Graph meta properties. Consider following meta tags.
<!--doc snippet at aurl.com -->
<meta property="og:title" content="a title" />
<meta property="og:description" content="a description" />
<meta property="article:published_time" content="2013-09-17T05:59:00+01:00" />
<meta property="og:price:amount" content="15.00" />
Below is a snippet showing its usage.
$ from webpreview import OpenGraph
# pass a URL and a list of meta properties
$ og = OpenGraph("http://aurl.com", ["og:title", "article:published_time", "og:price:amount"])
# OpenGraph dynamically assigns corresponding properties to its instance. As you will see it excludes `og:` from the supplied properties.
$ og.title
=> "a title"
$ og.published_time
=> "2013-09-17T05:59:00+01:00"
# It converts `:` in a property into `_`.
$ og.price_amount
=> "15.00"
## Twitter Card
API: `TwitterCard(url, properties, timeout?, headers?, content?, parser?)`
`TwitterCard` extracts Twitter Card meta properties from the given webpage. Its usage is similar to `OpenGraph`.
$ from webpreview import TwitterCard
$ tc = TwitterCard("aurl.com", ["twitter:title", "twitter:image"])
$ tc.title
$ tc.image
## Schema
API: `Schema(url, properties, timeout?, headers?, content?, parser?)`
Webpreview supports Schema through the class `Schema`. Right now it extracts properties in meta tags only.
$ from webpreview import Schema
$ aschema = Schema("aurl.com", ["name", "camelCaseProperty"]
$ aschema.name
# It makes Camel Case properties available as Snake Case.
$ aschema.camel_case_property
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size webpreview-1.6.0-py3-none-any.whl (9.2 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Close
Hashes for webpreview-1.6.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b2916980f03f40ef40f6bc2421077f409efec2200336acc8cff788c29aecf434 |
|
| MD5 | 54a22a061e730b372f2435a581876623 |
|
| BLAKE2-256 | 910073ebd3d699bfc47f3265a63316917260460d665b45891537a581aa517ad0 |
