Skip to main content

Make your FastAPI app installable on mobile devices.

Project description

🚀 FastPWA

FastPWA is a minimal FastAPI extension that makes your app installable as a Progressive Web App (PWA). It handles manifest generation, service worker registration, and automatic asset injection—giving you a native-like install prompt with almost no setup.

🌟 What It Does

  • 🧾 Generates a compliant webmanifest from your app metadata
  • ⚙️ Registers a basic service worker for installability
  • 🖼️ Discovers and injects favicon and static assets (index.css, index.js, etc.)
  • 🧩 Mounts static folders and serves your HTML entrypoint

📦 Installation

pip install fastpwa

🧪 Quickstart

from fastpwa import PWA

app = PWA(title="My App", summary="Installable FastAPI app", prefix="app")
app.static_mount("static")  # Mounts static assets and discovers favicon

app.register_pwa(html="static/index.html")  # Registers manifest, SW, and index route

📁 Static Folder Layout

FastPWA auto-discovers and injects these assets if present:

static/
├── index.html
├── index.css
├── index.js
├── global.css
├── global.js
└── favicon.png

🧬 Manifest Customization

You can override manifest fields via register_pwa():

app.register_pwa(
    html="static/index.html",
    app_name="MyApp",
    app_description="A simple installable app",
    color="#3367D6",
    background_color="#FFFFFF"
)

📜 License

MIT

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

fastpwa-0.4.2b0.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fastpwa-0.4.2b0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file fastpwa-0.4.2b0.tar.gz.

File metadata

  • Download URL: fastpwa-0.4.2b0.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.26.6 CPython/3.14.3 Linux/6.14.0-1017-azure

File hashes

Hashes for fastpwa-0.4.2b0.tar.gz
Algorithm Hash digest
SHA256 ed73f16ef532289fab07561bfd5cb94ff5a7ea5747f1efec3dd65b73e8846fca
MD5 113d053fda6f5b3137b0428e399904ed
BLAKE2b-256 ddaca0dddc2317213049b0380a7b7ae504e79666c89072a7e888ad6f07d06bb9

See more details on using hashes here.

File details

Details for the file fastpwa-0.4.2b0-py3-none-any.whl.

File metadata

  • Download URL: fastpwa-0.4.2b0-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.26.6 CPython/3.14.3 Linux/6.14.0-1017-azure

File hashes

Hashes for fastpwa-0.4.2b0-py3-none-any.whl
Algorithm Hash digest
SHA256 95d26aa4ffb455289f72ed9bc1ac5d545f339adf49e764bd755acd0623a90734
MD5 bcbfb61b77a8c130cb927e3c23f79df5
BLAKE2b-256 8956e92fe8399914caeda0e8bf8de0d25913ac3fa0749053d9b40d4caa705ff6

See more details on using hashes here.

Supported by

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