A Flask extension that integrates with Vite
Project description
Canonical Webteam Flask-Vite integration
A Flask extension that integrates with Vite, enabling use of Vite's dev server and static builds with as little configuration as possible.
Features
- easy to configure
- simple API
- supports custom Vite configurations
- supports multiple JS entry points
- supports all Vite-compatible JS frameworks
- supports all Vite-compatible stylesheet languages
- hot reloading in development mode
modulepreloadhints for JS chunks in production mode- injects
nonceattributes intoscriptandlinktags automatically (ifflask.request.CSP_NONCEis set)
How to use the extension
Install
To install this extension as a requirement in your project, you can use PIP:
pip install canonicalwebteam.flask-vite
Update your Vite configuration
Set build.manifest to true in your Vite config.
Configure
The extension reads the following values from the Flask app.config object:
VITE_MODE: "development" | "production"- type of environment in which the Vite integration will run. Defaults to"production".VITE_PORT: int- port where Vite's dev server is running. Defaults to5173.VITE_OUTDIR: str- file system path where the Vite output is expected; the path can be absolute or relative to the Flask app's root directory. Defaults to"static/dist".VITE_REACT: bool- only needed for React projects; set toTrueto inject React HMR dev tools in dev mode. Defaults toFalse.
Note: the extension does NOT manage the state of the Vite dev server nor produce the static builds, you are responsible for running the appropriate Vite commands before initializing the extension.
Initialize
from canonicalwebteam.flask_vite import FlaskVite
vite = FlaskVite()
vite.init_app(app)
Import resources
The extension adds a new template global function named vite_import. To include a script or stylesheet, simply invoke this template function passing the path to the file you want to import, relative to the app's root directory.
Example
To import a script whose path is < flask app directory >/js/app/main.ts:
{ vite_import("js/app/main.ts") }
Note: when importing a file via
vite_import, make sure it's also declared as an entry point in your Vite config (underbuild.rollupOptions.input); if this isn't the case, the import will break in production mode. This is because Vite's build won't contain the file you're trying to import, sovite_importwill throw aManifestContentExceptionwhen attempting to resolve the filesystem path.
Minimal usage example
# app.py
# ...
app.config["VITE_MODE"] = "development" if app.debug else "production"
FlaskVite(app)
#...
<!-- templates/index.html -->
<head>
{ vite_import("path/to/source/styles.scss") }
</head>
<body>
{ vite_import("path/to/source/file.tsx") }
</body>
For a more fleshed-out example check the example directory.
Development
The package leverages poetry for dependency management.
To set up the virtual env and install dependencies, run:
poetry install
Testing
Unit tests can be run using:
poetry run python3 -m unittest discover tests
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 canonicalwebteam_flask_vite-0.4.0.tar.gz.
File metadata
- Download URL: canonicalwebteam_flask_vite-0.4.0.tar.gz
- Upload date:
- Size: 8.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0a6c311ff09dd26e260a9555538eb49b350a1cb500f72b0c27944d8bdada810b
|
|
| MD5 |
d561b264aa93c7eb0286c378afb5e7c9
|
|
| BLAKE2b-256 |
f009da47bde016c99063bc5715fdb03b90f7092996b05581f2421724b260f7e7
|
File details
Details for the file canonicalwebteam_flask_vite-0.4.0-py3-none-any.whl.
File metadata
- Download URL: canonicalwebteam_flask_vite-0.4.0-py3-none-any.whl
- Upload date:
- Size: 11.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
41bd2794fae37075e3a9269886f08d189c5c800d7285d554b9b07521512cef15
|
|
| MD5 |
0f1ab6658f17879e0b4f2b5d625f610a
|
|
| BLAKE2b-256 |
4e332fe1263000e6c12b5cdf0676f2ce445eebb15a8e98a24221466adf3a1b37
|
