High-performance asset caching for multi-page applications
Project description
Skybolt Python
Python adapter for Skybolt - High-performance asset caching for multi-page applications.
Installation
pip install skybolt
Or with uv:
uv add skybolt
Prerequisites
- Install and configure the Vite plugin:
npm install @skybolt/vite-plugin - Build your project:
npm run build - Ensure
render-map.jsonis generated in your build output
Usage
from skybolt import Skybolt
# Initialize with render map path and cookies
sb = Skybolt("dist/.skybolt/render-map.json", cookies=request.cookies)
<!DOCTYPE html>
<html>
<head>
{{ sb.css("src/css/critical.css")|safe }}
{{ sb.launch_script()|safe }}
{{ sb.css("src/css/main.css")|safe }}
</head>
<body>
<h1>Hello Skybolt!</h1>
{{ sb.script("src/js/app.js")|safe }}
</body>
</html>
API
Skybolt(render_map_path, cookies=None, cdn_url=None)
Create a new Skybolt instance.
render_map_path- Path torender-map.jsongenerated by Vite plugincookies- Cookie dictionary (defaults toNone)cdn_url- Optional CDN URL prefix (e.g.,'https://cdn.example.com')
# Basic usage
sb = Skybolt("dist/.skybolt/render-map.json", cookies=request.cookies)
# With CDN
sb = Skybolt(
"dist/.skybolt/render-map.json",
cookies=request.cookies,
cdn_url="https://cdn.example.com"
)
css(entry: str, async_load: bool = False) -> str
Render CSS asset.
- First visit: Inlines CSS with caching attributes
- Repeat visit: Outputs
<link>tag (Service Worker serves from cache)
When async_load is True, CSS loads non-blocking:
- First visit: Uses
media="print"trick, swaps toallon load - Repeat visit: Uses
<link rel="preload">withonload
# Blocking (default) - for critical CSS
sb.css("src/css/critical.css")
# Non-blocking - for non-critical CSS
sb.css("src/css/main.css", async_load=True)
script(entry: str, module: bool = True) -> str
Render JavaScript asset.
- First visit: Inlines JS with caching attributes
- Repeat visit: Outputs
<script>tag (Service Worker serves from cache)
# ES module (default)
sb.script("src/js/app.js")
# Classic script
sb.script("src/js/legacy.js", module=False)
launch_script() -> str
Render the Skybolt client launcher. Call once in <head> before other assets.
<head>
{{ sb.launch_script()|safe }}
</head>
get_asset_url(entry: str) -> str | None
Get the URL for an asset (for manual use cases).
url = sb.get_asset_url("src/css/main.css")
# "/assets/main-Pw3rT8vL.css"
get_asset_hash(entry: str) -> str | None
Get the content hash for an asset.
hash = sb.get_asset_hash("src/css/main.css")
# "Pw3rT8vL"
preload(entry, as_type, mime_type=None, crossorigin=None, fetchpriority=None) -> str
Render preload link for critical resources like fonts and images.
# Preload hero image with high priority
sb.preload("images/hero.jpg", as_type="image", fetchpriority="high")
# Preload font
sb.preload("fonts/inter.woff2", as_type="font", mime_type="font/woff2", crossorigin="anonymous")
# Preload a Vite-built asset (resolved from render-map)
sb.preload("src/css/main.css", as_type="style")
Parameters:
entry- Source file path or direct URLas_type- Resource type ('image','font','style','script','fetch')mime_type- MIME type (e.g.,'font/woff2','image/webp')crossorigin- Crossorigin attribute ('anonymous','use-credentials')fetchpriority- Fetch priority ('high','low','auto')
Service Worker Setup
The Service Worker must be served from your domain root. Configure your web server:
Nginx:
location = /skybolt-sw.js {
alias /path/to/dist/skybolt-sw.js;
}
Apache (.htaccess):
RewriteRule ^skybolt-sw\.js$ dist/skybolt-sw.js [L]
Framework Integration
Django
# views.py
from skybolt import Skybolt
def index(request):
sb = Skybolt("static/.skybolt/render-map.json", cookies=request.COOKIES)
return render(request, "index.html", {"sb": sb})
<!-- templates/index.html -->
<!DOCTYPE html>
<html>
<head>
{{ sb.css("src/css/critical.css")|safe }}
{{ sb.launch_script()|safe }}
{{ sb.css("src/css/app.css")|safe }}
</head>
<body>
<!-- content -->
{{ sb.script("src/js/app.js")|safe }}
</body>
</html>
Flask
from flask import Flask, render_template, request
from skybolt import Skybolt
app = Flask(__name__)
@app.route("/")
def index():
sb = Skybolt("static/.skybolt/render-map.json", cookies=request.cookies)
return render_template("index.html", sb=sb)
FastAPI
from fastapi import FastAPI, Request
from fastapi.responses import HTMLResponse
from fastapi.templating import Jinja2Templates
from skybolt import Skybolt
app = FastAPI()
templates = Jinja2Templates(directory="templates")
@app.get("/", response_class=HTMLResponse)
async def index(request: Request):
sb = Skybolt("static/.skybolt/render-map.json", cookies=request.cookies)
return templates.TemplateResponse("index.html", {"request": request, "sb": sb})
Requirements
- Python 3.10+
- Vite with
@skybolt/vite-plugin
License
MIT
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 skybolt-3.4.0.tar.gz.
File metadata
- Download URL: skybolt-3.4.0.tar.gz
- Upload date:
- Size: 7.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0e6a1ea52415f224de377a43570f7545c6b381c785886174ffe64c4d481643c2
|
|
| MD5 |
2168258d1a49ce67a67474f5201069a6
|
|
| BLAKE2b-256 |
0dc96ae4b4612ff8eda87e7e490d3990fa7136c3696d43eff51da400b15d90f1
|
Provenance
The following attestation bundles were made for skybolt-3.4.0.tar.gz:
Publisher:
tag-and-publish.yml on JensRoland/skybolt-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
skybolt-3.4.0.tar.gz -
Subject digest:
0e6a1ea52415f224de377a43570f7545c6b381c785886174ffe64c4d481643c2 - Sigstore transparency entry: 734606985
- Sigstore integration time:
-
Permalink:
JensRoland/skybolt-python@f8edab1cdc46da9583c900e650856255817ee14f -
Branch / Tag:
refs/heads/main - Owner: https://github.com/JensRoland
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
tag-and-publish.yml@f8edab1cdc46da9583c900e650856255817ee14f -
Trigger Event:
push
-
Statement type:
File details
Details for the file skybolt-3.4.0-py3-none-any.whl.
File metadata
- Download URL: skybolt-3.4.0-py3-none-any.whl
- Upload date:
- Size: 9.2 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 |
f89ed4f43313b09de607459fe6a8015f815ffe3a9396dae42a757ca6799b7257
|
|
| MD5 |
e86d7330b700b04c48ab407f7316746e
|
|
| BLAKE2b-256 |
b5bebbe6bed0383238dbf26640ff9633127bcac40ddf86518195752cd5cc2737
|
Provenance
The following attestation bundles were made for skybolt-3.4.0-py3-none-any.whl:
Publisher:
tag-and-publish.yml on JensRoland/skybolt-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
skybolt-3.4.0-py3-none-any.whl -
Subject digest:
f89ed4f43313b09de607459fe6a8015f815ffe3a9396dae42a757ca6799b7257 - Sigstore transparency entry: 734607065
- Sigstore integration time:
-
Permalink:
JensRoland/skybolt-python@f8edab1cdc46da9583c900e650856255817ee14f -
Branch / Tag:
refs/heads/main - Owner: https://github.com/JensRoland
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
tag-and-publish.yml@f8edab1cdc46da9583c900e650856255817ee14f -
Trigger Event:
push
-
Statement type: