Litestar plugins

Home for plugins for Litestar

Plugins Database

Metadata of litestar plugins are maintained in yml files inside ./plugins directory and automatically synced from upstream to fetch latest information.

Add/Update a plugin

Create a PR:

• Copy the example.yml file.
• Image must be svg or png

Commands

• Sync: Update plugin metadata from upstream sources

uv run sync

• Get README: Fetch README files for all plugins

uv run get-readme

Contribution

• If you feel a plugin is missing, please create a new issue
• If some data is outdated please directly open a pull request

Schema

Field Name	Required	Description
key	✅	Unique identifier for the plugin
name	✅	Name displayed on the website
description	✅	Short description
repo	✅	GitHub repository. Format is org/name or org/name#main/path
pypi	✅	PyPi package name
github	✅	GitHub URL
website	✅	Website URL
documentation	✅	Link to the documentation
category	✅	Plugin category from (TODO: Define a list of categories)
type	✅	official (for litestar-org) or 3rd-party
maintainers	✅	List of maintainers each item has name, github and avatar
compatibility	✅	Plugins compatibility status. litestar field specifies semver of supported litestar version
icon	❔	Icon of plugin from ./icons directory
stars	❔	GitHub repository star count (auto-populated)
monthly_downloads	❔	Monthly downloads from PyPI Stats (auto-populated)
latest_version	❔	Latest version from PyPI (auto-populated)
created_at	❔	Plugin creation date from PyPI releases (auto-populated)
updated_at	❔	Plugin last update date from PyPI releases (auto-populated)
python_compatibility_raw	❔	Raw Python version requirement string from PyPI (auto-populated)
python_compatibility	❔	Parsed Python compatibility object with raw, specifier_set, and compatible fields (auto-populated)
changelog	❔	Changelog URL from PyPI project_urls (auto-populated)
issues	❔	Issues/Bug tracker URL from PyPI project_urls (auto-populated)

Warning

Modifying the schema there needs to be done also in the litestar.dev website repository.