Skip to main content

Extracts OpenGraph, TwitterCard and Schema properties from a webpage.

Project description


For a given URL, webpreview extracts its title, description, and image url using Open Graph, Twitter Card, or Schema meta tags, or, as an alternative, parses it as a generic webpage.

PyPI - Python Version PyPI Build status Code coverage report


pip install webpreview


Use the generic webpreview method (added in v1.7.0) to parse the page independent of its nature. This method fetches a page and tries to extracts a title, description, and a preview image from it.

It first attempts to parse the values from Open Graph properties, then it falls back to Twitter Card format, and then to Schema. If none of these methods succeed in extracting all three properties, then the web page's content is parsed using a generic HTML parser.

>>> from webpreview import webpreview

>>> p = webpreview("")
>>> p.title
'Enrico Fermi - Wikipedia'
>>> p.description
'Italian-American physicist (1901–1954)'
>>> p.image

# Access the parsed fields both as attributes and items
>>> p["url"] == p.url

# Check if all three of the title, description, and image are in the parsing result
>>> p.is_complete()

# Provide page content from somewhere else
>>> content = """
        <title>The Dormouse's story</title>
        <meta property="og:description" content="A Mad Tea-Party story" />
        <p class="title"><b>The Dormouse's story</b></p>
        <a href="" class="sister" id="link1">Elsie</a>

# The the function's invocation won't make any external calls,
# only relying on the supplied content, unlike the example above
>>> webpreview("", content=content)
WebPreview(url="", title="The Dormouse's story", description="A Mad Tea-Party story")

Using the command line

When webpreview is installed via pip, then the accompanying command-line tool is installed alongside.

$ webpreview
title: Enrico Fermi - Wikipedia
description: Italian-American physicist (1901–1954)

$ webpreview --absolute-url
title: GitHub: Where the world builds software
description: GitHub is where over 83 million developers shape the future of software, together.

Using compatibility API

Before v1.7.0 the package mainly exposed a different set of the API methods. All of them are supported and may continue to be used.


from webpreview import web_preview
title, description, image = web_preview("")

# specifing timeout which gets passed to requests.get()
title, description, image = web_preview("", timeout=1000)

# passing headers
headers = {'User-Agent': 'Mozilla/5.0'}
title, description, image = web_preview("", 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("", content=content)

# specifing the parser
# by default webpreview uses 'html.parser'
title, description, image = web_preview("", content=content, parser='lxml')

Run with Docker

The docker image can be built and ran similarly to the command line. The default entry point is the webpreview command-line function.

$ docker build -t webpreview .
$ docker run -it --rm webpreview ""
title: Enrico Fermi - Wikipedia
description: Enrico Fermi (Italian: [enˈriːko ˈfermi]; 29 September 1901  28 November 1954) was an Italian (later naturalized American) physicist and the creator of the world's first nuclear reactor, the Chicago Pile-1. He has been called the "architect of the nuclear age"[1] and the "architect of the atomic bomb".

Note: built docker image weighs around 210MB.


# Execute the tests
poetry run pytest webpreview

# OR execute until the first failed test
poetry run pytest webpreview -x

Setting up development environment

# Install a correct minimal supported version of python
pyenv install 3.7.13

# Create a virtual environment
# By default, the project already contains a .python-version file that points
# to 3.7.13.
python -m venv .venv

# Install dependencies
# Poetry will automatically install them into the local .venv
poetry install

# If you have errors likes this:
ERROR: Can not execute `` since setuptools is not available in the build environment.

# Then do this:
.venv/bin/pip install --upgrade setuptools

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

webpreview-1.7.2.tar.gz (16.1 kB view hashes)

Uploaded source

Built Distribution

webpreview-1.7.2-py3-none-any.whl (18.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page