Metadata-Version: 2.1
Name: fastapi-vite
Version: 0.1.6
Summary: Helper Utilities for loading assets genated from Vite manifests
Home-page: https://github.com/cofin/fastapi-vite
License: MIT
Keywords: fastapi,starlette,vite
Author: Cody Fincher
Author-email: cody.fincher@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: orjson
Requires-Dist: Jinja2
Requires-Dist: fastapi
Requires-Dist: starlette
Project-URL: Repository, https://github.com/cofin/fastapi-vite
Description-Content-Type: text/markdown

# fastapi-vite

Integration for FastAPI and Vite JS

## what?

This package is designed to make working with javascript assets easier.

fastapi-vite enables the jinja filters required to render asset URLs to jinja templates

## installation

Install using pip

```shell
pip install fastapi-vite
```

## Usage

Configure Jinja templating for FastAPI

```python
templates = Jinja2Templates(directory='templates')
templates.env.globals['render_vite_hmr_client'] = fastapi_vite.render_vite_hmr_client
templates.env.globals['asset_url'] = fastapi_vite.asset_url

```

### Configure Vite

### Configure Static Assets

### Configure Templates

\*render_vite_hmr no-op when in production.

```html
{{ render_vite_hmr_client() }}

<script
  type="text/javascript"
  defer
  src="{{ asset_url('javascript/main.tsx') }}"
></script>
```

