Metadata-Version: 2.1
Name: litestar-vite
Version: 0.1.2
Summary: Vite plugin for Litestar
Project-URL: Changelog, https://cofin.github.io/litestar-vite/latest/changelog
Project-URL: Discord, https://discord.gg/X3FJqy8d2j
Project-URL: Documentation, https://cofin.github.io/litestar-vite/latest/
Project-URL: Homepage, https://cofin.github.io/litestar-vite/latest/
Project-URL: Issue, https://github.com/cofin/litestar-vite/issues/
Project-URL: Source, https://github.com/cofin/litestar-vite
Author-email: Cody Fincher <cody.fincher@gmail.com>
License: MIT
License-File: LICENSE
Keywords: litestar,vite
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Database
Classifier: Topic :: Database :: Database Engines/Servers
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Requires-Python: >=3.8
Requires-Dist: litestar[cli,jinja]>=2.0.1
Description-Content-Type: text/markdown

# Litestar Vite

> [!IMPORTANT]
> This plugin currently contains minimal features and is a work-in-progress

## Installation

```shell
pip install litestar-vite
```

## Usage

Here is a basic application that demonstrates how to use the plugin.

```python
from __future__ import annotations

from litestar import Litestar
from litestar_vite import ViteConfig, VitePlugin

vite = VitePlugin(
    config=ViteConfig(
        static_dir="./local_static_dir",
        templates_dir="./path_to_jinja_templates",
        # Should be False when in production
        hot_reload=True, # Websocket HMR asset reloading is enabled when true.
        port=3005,
    ),
)
app = Litestar(plugins=[vite])

```
