Grab OpenGraph and Twitter Cards metadata from URLs, HTML documents and Spotify links
Project description
Tweesky
Tweesky is a Python library for extracting HTML, OpenGraph and Twitter metadata from URLs, HTML pages and Spotify links.
- Check Tweesky Web Site: example of what Tweesky can do
- Read Intro on Medium
How to use it
Install the module: PyPi Tweesky page
Grab attributes from a URL
import tweesky.main as tweesky
website = 'https://www.nike.com/'
card = tweesky.generate_card(url=website)
print(card.title)
print(card.image)
Grab attributes from an HTML document
import tweesky.main as tweesky
with open('doc.html', 'r') as reader:
doc = reader.readlines()
card = tweesky.generate_card(html=doc)
print(card.title)
print(card.image)
Output options
There are different options to format the card:
- Card object (default): access the Python object to obtain the metadata
- JSON output: the Card content is provided as JSON
- HTML file: an HTML file is provided including the metadata necessary for creating the Social Media preview
HTML format
When using main.generate_card_as_html() method the output is an HTML document which can be shared as-is on Social Media.
The HTML document provides all necessary OpenGraph/Twitter tags as well as the Javascript code to redirect the users to the original page: save the file on an accessible location and distribute the link through the Social Media channels.
<html>
<head>
<meta name="twitter:card" content="summary" />
<meta name="twitter:title" content="Python Tutorials – Real Python" />
<meta name="twitter:description" content="Learn Python online" />
<meta name="twitter:image" content="https://cdn.realpython.com/static/logo.png" />
<meta name="twitter:site" content="@realpython" />
<meta property="og:title" content="Python Tutorials – Real Python" />
<meta property="og:description" content="Learn Python online" />
<meta property="og:image" content="https://cdn.realpython.com/static/logo.png" />
<meta http-equiv="refresh" content="0; url=https://realpython.com/" />
</head>
<body >
</body>
</html>
Images
When finding the image for the Preview the library will search the following:
- Twitter Card metadata
- OpenGraph metadata
- JSON LD
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file tweesky-0.0.6.tar.gz.
File metadata
- Download URL: tweesky-0.0.6.tar.gz
- Upload date:
- Size: 16.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 88d8cca30657cfe1ee2abd5525968ef314214a09d36be9f763a54282f3b1863b |
|
| MD5 | 28aae1ca3aacf6bf6eb4e1948fb9c7c9 |
|
| BLAKE2b-256 | 55aa82fd780850e94c6d711ea55ac2fd1f3200fa99b2e6573838603dc6fc5c7a |
File details
Details for the file tweesky-0.0.6-py3-none-any.whl.
File metadata
- Download URL: tweesky-0.0.6-py3-none-any.whl
- Upload date:
- Size: 18.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b99bbfabcd6a46c1abeb44017c897285c7b0a8fc5bc91dac44f79db61b45d57d |
|
| MD5 | babfe0310575876ce0f5292212e1e9ac |
|
| BLAKE2b-256 | e12d4dfd3579adb976dd370394828ffd7b14693822ec48819a1e6d357cd19138 |
