A simple python package to generate HTML head tags.
Project description
pyhead 🐍🤯
The Python HTML <head> filler.
pip install pyhead
What is Pyhead?
Pyhead is a Python package that helps you generate the <head> tag for your HTML pages.
Flask example
from flask import Flask, render_template
from pyhead import Head
from pyhead import elements as e
def create_app():
app = Flask(__name__)
@app.route("/")
def index():
head = Head([
e.Page(
title="Hello World",
description="This is a test",
keywords="test, hello, world",
subject="Hello World",
rating="General",
),
e.Base("http://127.0.0.1:5000"),
e.Robots("index, follow"),
e.ContentSecurityPolicy(),
e.ReferrerPolicy("no-referrer"),
e.Google(
googlebot="index, follow",
no_sitelinks_search_box=True,
no_translate=True,
),
e.Verification(
google="1234567890",
yandex="1234567890",
bing="1234567890",
alexa="1234567890",
),
e.GeoPosition(
icbm="55.86013028402754, -4.252019430273945",
geo_position="55.86013028402754;-4.252019430273945",
geo_region="en_GB",
geo_placename="Duke of Wellington",
),
e.SocialMediaCard(
site_account="@example",
creator_account="@example",
title="Example",
description="Example",
image="https://example.com/image.png",
image_alt="Example",
site_name="Example",
url="https://example.com",
locale="en_US",
),
e.Favicon(
ico_icon_href="/static/favicons/favicon.ico",
png_icon_16_href="/static/favicons/favicon-16x16.png",
png_icon_32_href="/static/favicons/favicon-32x32.png",
png_icon_64_href="/static/favicons/favicon-64x64.png",
png_icon_96_href="/static/favicons/favicon-96x96.png",
png_icon_180_href="/static/favicons/favicon-180x180.png",
png_icon_196_href="/static/favicons/favicon-196x196.png",
png_apple_touch_icon_57_href="/static/favicons/apple-touch-icon-57x57.png",
png_apple_touch_icon_60_href="/static/favicons/apple-touch-icon-60x60.png",
png_apple_touch_icon_72_href="/static/favicons/apple-touch-icon-72x72.png",
png_apple_touch_icon_76_href="/static/favicons/apple-touch-icon-76x76.png",
png_apple_touch_icon_114_href="/static/favicons/apple-touch-icon-114x114.png",
png_apple_touch_icon_120_href="/static/favicons/apple-touch-icon-120x120.png",
png_apple_touch_icon_144_href="/static/favicons/apple-touch-icon-144x144.png",
png_apple_touch_icon_152_href="/static/favicons/apple-touch-icon-152x152.png",
png_apple_touch_icon_167_href="/static/favicons/apple-touch-icon-167x167.png",
png_apple_touch_icon_180_href="/static/favicons/apple-touch-icon-180x180.png",
png_mstile_70_href="/static/favicons/mstile-70x70.png",
png_mstile_270_href="/static/favicons/mstile-270x270.png",
png_mstile_310x150_href="/static/favicons/mstile-310x150.png",
png_mstile_310_href="/static/favicons/mstile-310x150.png",
),
e.Link(rel="canonical", href="https://example.com"),
e.Link(rel="canonical", href="https://example.co.uk"),
e.Script(type_="module", src="/static/example.js"),
e.Stylesheet("/static/main.css"),
])
return render_template("index.html", head=head)
return app
index.html:
<!DOCTYPE html>
<html lang="en">
<head>
<title>{{ head.title }}</title>
{{ head.compile(skip_title=True) }}
</head>
<body>
{% block content %}
{% endblock %}
</body>
</html>
or
<!DOCTYPE html>
<html lang="en">
<head>
{{ head.compile() }}
</head>
<body>
{% block content %}
{% endblock %}
</body>
</html>
Results in:
<html lang="en">
<head>
<title>Hello World</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1" >
<meta name="description" content="This is a test" >
<meta name="keywords" content="test, hello, world">
<meta name="subject" content="Hello World" >
<meta name="rating" content="General" >
<base href="http://127.0.0.1:5000">
<meta name="robots" content="index, follow" >
<meta http-equiv="Content-Security-Policy" content="default-src 'self'" >
<meta name="referrer" content="no-referrer" >
<meta name="googlebot" content="index, follow" >
<meta name="google" content="notranslate" >
<meta name="google-site-verification" content="1234567890" >
<meta name="yandex-verification" content="1234567890" >
<meta name="msvalidate.01" content="1234567890" >
<meta name="alexaVerifyID" content="1234567890" >
<meta name="ICBM" content="55.86013028402754, -4.252019430273945" >
<meta name="geo.position" content="55.86013028402754;-4.252019430273945" >
<meta name="geo.region" content="en_GB" >
<meta name="geo.placename" content="Duke of Wellington" >
<meta name="twitter:card" content="summary_large_image" >
<meta name="twitter:site" content="@example" >
<meta name="twitter:creator" content="@example" >
<meta name="twitter:title" content="Example" >
<meta name="twitter:description" content="Example" >
<meta name="twitter:image" content="https://example.com/image.png" >
<meta name="twitter:image:alt" content="Example" >
<meta name="twitter:url" content="https://example.com" >
<meta property="og:type" content="website" >
<meta property="og:locale" content="en_US" >
<meta property="og:site_name" content="Example" >
<meta property="og:title" content="Example" >
<meta property="og:description" content="Example" >
<meta property="og:image" content="https://example.com/image.png" >
<meta property="og:image:alt" content="Example" >
<meta property="og:url" content="https://example.com" >
<link rel="icon" href="/static/favicons/favicon.ico" sizes="16x16 32x32" type="image/x-icon">
<link rel="icon" href="/static/favicons/favicon-16x16.png" sizes="16x16" type="image/png">
<link rel="icon" href="/static/favicons/favicon-32x32.png" sizes="32x32" type="image/png">
<link rel="icon" href="/static/favicons/favicon-64x64.png" sizes="64x64" type="image/png">
<link rel="icon" href="/static/favicons/favicon-96x96.png" sizes="96x96" type="image/png">
<link rel="icon" href="/static/favicons/favicon-180x180.png" sizes="180x180" type="image/png">
<link rel="icon" href="/static/favicons/favicon-196x196.png" sizes="196x196" type="image/png">
<link rel="apple-touch-icon" href="/static/favicons/apple-touch-icon-57x57.png" sizes="57x57" type="image/png">
<link rel="apple-touch-icon" href="/static/favicons/apple-touch-icon-60x60.png" sizes="60x60" type="image/png">
<link rel="apple-touch-icon" href="/static/favicons/apple-touch-icon-72x72.png" sizes="72x72" type="image/png">
<link rel="apple-touch-icon" href="/static/favicons/apple-touch-icon-76x76.png" sizes="76x76" type="image/png">
<link rel="apple-touch-icon" href="/static/favicons/apple-touch-icon-114x114.png" sizes="114x114" type="image/png">
<link rel="apple-touch-icon" href="/static/favicons/apple-touch-icon-120x120.png" sizes="120x120" type="image/png">
<link rel="apple-touch-icon" href="/static/favicons/apple-touch-icon-144x144.png" sizes="144x144" type="image/png">
<link rel="apple-touch-icon" href="/static/favicons/apple-touch-icon-152x152.png" sizes="152x152" type="image/png">
<link rel="apple-touch-icon" href="/static/favicons/apple-touch-icon-167x167.png" sizes="167x167" type="image/png">
<link rel="apple-touch-icon" href="/static/favicons/apple-touch-icon-180x180.png" sizes="180x180" type="image/png">
<link rel="msapplication-square70x70logo" href="/static/favicons/mstile-70x70.png">
<link rel="msapplication-square270x270logo" href="/static/favicons/mstile-270x270.png">
<link rel="msapplication-wide310x150logo" href="/static/favicons/mstile-310x150.png">
<link rel="msapplication-wide310x150logo" href="/static/favicons/mstile-310x150.png">
<link rel="canonical" href="https://example.com">
<link rel="canonical" href="https://example.co.uk">
<script src="/static/example.js" type="module"></script>
<link rel="stylesheet" href="/static/main.css">
</head>
<body>
<h1>Flask App</h1>
<p>Right-Click view source</p>
</body>
</html>
Usage Examples
Route by Route
...
from pyhead import Head
from pyhead import elements as e
...
@app.get("/")
def index():
head = Head([
e.Page(
title="Hello World",
description="This is a test",
keywords="test, hello, world",
subject="Hello World",
rating="General",
)
])
return render_template("index.html", head=head)
Copy and Extend
app/page_head.py
...
from pyhead import Head
from pyhead import elements as e
...
head = Head([
e.Page(
title="Hello World",
description="This is a test",
keywords="test, hello, world",
subject="Hello World",
rating="General",
)
])
app/__init__.py
...
from app.page_head import head
from pyhead import elements as e
...
@app.get("/my-cool-page")
def my_cool_page():
my_cool_page_head = head.copy().extend([
e.Page(
title="This is my cool page",
description="This is a test",
keywords="test, hello, world",
subject="Hello World",
rating="General",
),
e.Robots(
"index, follow"
)
])
return render_template("my_cool_page.html", head=my_cool_page_head)
Class Defined
app/page_head.py
...
from pyhead import HeadClass
from pyhead import elements as e
...
class MyHead(HeadClass):
elements = [
e.Page(
title="Hello World",
description="This is a test",
keywords="test, hello, world",
subject="Hello World",
rating="General",
)
]
app/__init__.py
...
from app.page_head import MyHead
from pyhead import elements as e
...
@app.get("/my-cool-page")
def my_cool_page():
return render_template("my_cool_page.html", head=MyHead())
Flask Specific
url_for -> FlaskUrlFor
FlaskUrlFor is a class designed to lazily load the
url_for function found in Flask. This is done to ensure that
when compiled url_for will be invoked within context.
It has the same arguments as url_for but it will only
call the url_for function when the Head is compiled.
Here's an example of how to use it:
...
from pyhead import Head
from pyhead import elements as e
from pyhead.flask import FlaskUrlFor
...
@app.get("/my-cool-page")
def my_cool_page():
head = Head(
[
...,
e.Stylesheet(FlaskUrlFor("static", filename="main.css")),
...,
]
)
return render_template("my_cool_page.html", head=head)
CLI Commands
Generating favicons
You can generate favicons from a source image using the cli command pyhead favicons -s favicon-gen-test.png
This uses the python package favicons to generate the favicons.
You need to install the favicons package to use this command.
pip install favicons
All paths in the cli command are relative to the current working directory.
Only the following source formats are supported:
png, jpg, jpeg, gif, svg, tiff
-s, --source This will look for the image file to use
-o, --output This will be the output directory for the favicons
-hp, --href-prefix This will prefix the href tag in the output html
The following command:
pyhead favicons -s favicon-gen-test.png -o favicons -hp https://example.com
Will create a folder called favicons with the following files:
apple-touch-icon-57x57.png
apple-touch-icon-60x60.png
apple-touch-icon-72x72.png
apple-touch-icon-76x76.png
apple-touch-icon-114x114.png
apple-touch-icon-120x120.png
apple-touch-icon-144x144.png
apple-touch-icon-152x152.png
apple-touch-icon-167x167.png
apple-touch-icon-180x180.png
favicon-16x16.png
favicon-32x32.png
favicon-64x64.png
favicon-96x96.png
favicon-180x180.png
favicon-196x196.png
favicon-delete_me_after_use.html
favicon-delete_me_after_use.py
mstile-70x70.png
mstile-270x270.png
mstile-310x150.png
mstile-310x310.png
The favicon-delete_me_after_use.html file will contain the following:
<link rel="icon" href="https://example.com/favicon.ico" sizes="16x16 32x32">
<link rel="icon" href="https://example.com/favicon-16x16.png" sizes="16x16">
<link rel="icon" href="https://example.com/favicon-32x32.png" sizes="32x32">
<link rel="icon" href="https://example.com/favicon-64x64.png" sizes="64x64">
<link rel="icon" href="https://example.com/favicon-96x96.png" sizes="96x96">
<link rel="icon" href="https://example.com/favicon-180x180.png" sizes="180x180">
<link rel="icon" href="https://example.com/favicon-196x196.png" sizes="196x196">
<link rel="apple-touch-icon" href="https://example.com/apple-touch-icon-57x57.png" sizes="57x57">
<link rel="apple-touch-icon" href="https://example.com/apple-touch-icon-60x60.png" sizes="60x60">
<link rel="apple-touch-icon" href="https://example.com/apple-touch-icon-72x72.png" sizes="72x72">
<link rel="apple-touch-icon" href="https://example.com/apple-touch-icon-76x76.png" sizes="76x76">
<link rel="apple-touch-icon" href="https://example.com/apple-touch-icon-114x114.png" sizes="114x114">
<link rel="apple-touch-icon" href="https://example.com/apple-touch-icon-120x120.png" sizes="120x120">
<link rel="apple-touch-icon" href="https://example.com/apple-touch-icon-144x144.png" sizes="144x144">
<link rel="apple-touch-icon" href="https://example.com/apple-touch-icon-152x152.png" sizes="152x152">
<link rel="apple-touch-icon" href="https://example.com/apple-touch-icon-167x167.png" sizes="167x167">
<link rel="apple-touch-icon" href="https://example.com/apple-touch-icon-180x180.png" sizes="180x180">
<link rel="msapplication-square70x70logo" href="https://example.com/mstile-70x70.png">
<link rel="msapplication-square270x270logo" href="https://example.com/mstile-270x270.png">
<link rel="msapplication-wide310x150logo" href="https://example.com/mstile-310x150.png">
<link rel="msapplication-wide310x150logo" href="https://example.com/mstile-310x150.png">
The favicon-delete_me_after_use.py file will contain the following:
from pyhead.elements import Favicon
Favicon(
ico_icon_href="https://example.com/favicon.ico",
png_icon_16_href="https://example.com/favicon-16x16.png",
png_icon_32_href="https://example.com/favicon-32x32.png",
png_icon_64_href="https://example.com/favicon-64x64.png",
png_icon_96_href="https://example.com/favicon-96x96.png",
png_icon_180_href="https://example.com/favicon-180x180.png",
png_icon_196_href="https://example.com/favicon-196x196.png",
png_apple_touch_icon_57_href="https://example.com/apple-touch-icon-57x57.png",
png_apple_touch_icon_60_href="https://example.com/apple-touch-icon-60x60.png",
png_apple_touch_icon_72_href="https://example.com/apple-touch-icon-72x72.png",
png_apple_touch_icon_76_href="https://example.com/apple-touch-icon-76x76.png",
png_apple_touch_icon_114_href="https://example.com/apple-touch-icon-114x114.png",
png_apple_touch_icon_120_href="https://example.com/apple-touch-icon-120x120.png",
png_apple_touch_icon_144_href="https://example.com/apple-touch-icon-144x144.png",
png_apple_touch_icon_152_href="https://example.com/apple-touch-icon-152x152.png",
png_apple_touch_icon_167_href="https://example.com/apple-touch-icon-167x167.png",
png_apple_touch_icon_180_href="https://example.com/apple-touch-icon-180x180.png",
png_mstile_70_href="https://example.com/mstile-70x70.png",
png_mstile_270_href="https://example.com/mstile-270x270.png",
png_mstile_310x150_href="https://example.com/mstile-310x150.png",
png_mstile_310_href="https://example.com/mstile-310x150.png",
)
Remember to delete the favicon-delete_me_after_use.html and favicon-delete_me_after_use.py files after use.
Project details
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.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyhead-5.3.0.tar.gz.
File metadata
- Download URL: pyhead-5.3.0.tar.gz
- Upload date:
- Size: 91.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
13bc12f43f13847bf53b8ccd98dbb45e570895f2b0051e8e2d31c2cd21e8662c
|
|
| MD5 |
9834599c92907ec51d35fa284c2a3c52
|
|
| BLAKE2b-256 |
402f55df274caf3f2544f0e76941945ea3136d892ad4275d178f8a4c064dbab6
|
Provenance
The following attestation bundles were made for pyhead-5.3.0.tar.gz:
Publisher:
publish.yml on CheeseCake87/pyhead
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pyhead-5.3.0.tar.gz -
Subject digest:
13bc12f43f13847bf53b8ccd98dbb45e570895f2b0051e8e2d31c2cd21e8662c - Sigstore transparency entry: 524467831
- Sigstore integration time:
-
Permalink:
CheeseCake87/pyhead@638de89047447e54c644fabb282bfa3fe0bf70fe -
Branch / Tag:
refs/tags/5.3.0 - Owner: https://github.com/CheeseCake87
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@638de89047447e54c644fabb282bfa3fe0bf70fe -
Trigger Event:
release
-
Statement type:
File details
Details for the file pyhead-5.3.0-py3-none-any.whl.
File metadata
- Download URL: pyhead-5.3.0-py3-none-any.whl
- Upload date:
- Size: 25.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d5b9f5727c3be9ae0a73854fa4e81e4357c61cb4d021ef7a1aaff8afe5e84e44
|
|
| MD5 |
71a8d66b52b2b62483fee8b420c8cac5
|
|
| BLAKE2b-256 |
d1290c836170bd21560f3d19421ea364a645357dbcf4af4e61b7607a82843990
|
Provenance
The following attestation bundles were made for pyhead-5.3.0-py3-none-any.whl:
Publisher:
publish.yml on CheeseCake87/pyhead
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pyhead-5.3.0-py3-none-any.whl -
Subject digest:
d5b9f5727c3be9ae0a73854fa4e81e4357c61cb4d021ef7a1aaff8afe5e84e44 - Sigstore transparency entry: 524467855
- Sigstore integration time:
-
Permalink:
CheeseCake87/pyhead@638de89047447e54c644fabb282bfa3fe0bf70fe -
Branch / Tag:
refs/tags/5.3.0 - Owner: https://github.com/CheeseCake87
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@638de89047447e54c644fabb282bfa3fe0bf70fe -
Trigger Event:
release
-
Statement type: