diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cfc9d69..10a117c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -12,9 +12,9 @@ jobs: with: fetch-depth: 0 - - uses: actions/setup-node@v2 + - uses: actions/setup-node@v4 with: - node-version: 15 + node-version: 18 - run: npm install --global awesome-lint - run: awesome-lint README.md diff --git a/README.md b/README.md index 8ef3967..42db042 100644 --- a/README.md +++ b/README.md @@ -82,21 +82,17 @@ framework - [Documentation](https://docs.litestar.dev/) includes comprehensive API reference docs as well as usage guides. - - [Tutorial](https://docs.litestar.dev/latest/tutorials/) on Litestar, for people that are new to Litestar. - - [Source Code](https://github.com/litestar-org/litestar) is hosted on GitHub. - -- Connect with the Litestar community on [Discord](https://discord.com/invite/X3FJqy8d2j), [Twitter](https://twitter.com/LitestarAPI), and [Reddit](https://www.reddit.com/r/LitestarAPI/). - +- Connect with the Litestar community on [Discord](https://discord.com/invite/X3FJqy8d2j), [Twitter](https://twitter.com/LitestarAPI), and [Reddit](https://www.reddit.com/r/litestarapi). - [Litestar Blog](https://blog.litestar.dev/) - The official Litestar blog. #### Internal Utils -- [`litestar-asyncpg`](https://github.com/litestar-org/litestar-asyncpg) - A plugin for the AsyncPG database driver. [![Litestar Plugin Architecture](https://img.shields.io/badge/Litestar%20Plugin-%E2%AD%90%20Enabled-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://docs.litestar.dev/latest/usage/plugins.html) +- [`litestar-asyncpg`](https://github.com/litestar-org/litestar-asyncpg) - A plugin for the AsyncPG database driver.* - [`litestar-vite`](https://github.com/litestar-org/vite-plugin) - A Vite adapter for Litestar. -- [`litestar-piccolo`](https://github.com/litestar-org/litestar-piccolo) - A Piccolo ORM adapter for Litestar. [![Litestar Plugin Architecture](https://img.shields.io/badge/Litestar%20Plugin-%E2%AD%90%20Enabled-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://docs.litestar.dev/latest/usage/plugins.html) +- [`litestar-piccolo`](https://github.com/litestar-org/litestar-piccolo) - A Piccolo ORM adapter for Litestar.* ##### Built-in Extensions @@ -119,18 +115,16 @@ that you would normally find as third-party extensions in other frameworks. ### General +Items marked with * indicate they extend Litestar using [![Litestar Plugin Architecture](https://img.shields.io/badge/Litestar%20Plugin-%E2%AD%90%20Enabled-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://docs.litestar.dev/latest/usage/plugins/index.html) + - [`dishka`](https://github.com/reagento/dishka) - Cute DI framework with agreeable API and everything you need, including [Litestar integration](https://dishka.readthedocs.io/en/stable/integrations/index.html). - [`litestar-MQTT`](https://github.com/Alurith/litestar-mqtt) - A plugin for the MQTT protocol. -- [`litestar-saq`](https://github.com/cofin/litestar-saq) - A plugin for the [SAQ job queuing framework](https://github.com/tobymao/saq) [![Litestar Plugin Architecture](https://img.shields.io/badge/Litestar%20Plugin-%E2%AD%90%20Enabled-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://docs.litestar.dev/latest/usage/plugins.html) -- [`litestar-taskiq`](https://github.com/taskiq-python/taskiq-litestar) - [Taskiq](https://taskiq-python.github.io/) integration for Litestar -- [`litestar-aiosql`](https://github.com/cofin/litestar-aiosql) - - A plugin for the [aiosql](https://github.com/cofin/litestar-granian) database query builder. [![Litestar Plugin Architecture](https://img.shields.io/badge/Litestar%20Plugin-%E2%AD%90%20Enabled-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://docs.litestar.dev/latest/usage/plugins.html) -- [`litestar-granian`](https://github.com/cofin/litestar-granian) - - A plugin for the [Granian](https://github.com/emmett-framework/granian) HTTP server, written in Rust. [![Litestar Plugin Architecture](https://img.shields.io/badge/Litestar%20Plugin-%E2%AD%90%20Enabled-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://docs.litestar.dev/latest/usage/plugins.html) -- [`litestar-svcs`](https://github.com/guacs/litestar-svcs) - - A plugin for the [SVCS](https://github.com/hynek/svcs) service locater/dependency injection library. [![Litestar Plugin Architecture](https://img.shields.io/badge/Litestar%20Plugin-%E2%AD%90%20Enabled-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://docs.litestar.dev/latest/usage/plugins.html) -- [`litestar-saq-htmx`](https://github.com/euri10/litestar_saq_htmx) - - Proof of concept using SAQ, Litestar, HTMX, and Server-Sent events for a simple SAQ job monitor +- [`litestar-saq`](https://github.com/cofin/litestar-saq) - A plugin for the [SAQ job queuing framework](https://github.com/tobymao/saq)* +- [`litestar-taskiq`](https://github.com/taskiq-python/taskiq-litestar) - [Taskiq](https://taskiq-python.github.io/) integration for Litestar. +- [`litestar-aiosql`](https://github.com/cofin/litestar-aiosql) - A plugin for the [aiosql](https://github.com/nackjicholson/aiosql) database query builder.* +- [`litestar-granian`](https://github.com/cofin/litestar-granian) - A plugin for the [Granian](https://github.com/emmett-framework/granian) HTTP server, written in Rust.* +- [`litestar-svcs`](https://github.com/guacs/litestar-svcs) - A plugin for the [SVCS](https://github.com/hynek/svcs) service locater/dependency injection library.* +- [`litestar-saq-htmx`](https://github.com/euri10/litestar_saq_htmx) - Proof of concept using SAQ, Litestar, HTMX, and Server-Sent events for a simple SAQ job monitor. ### Admin @@ -141,7 +135,7 @@ that you would normally find as third-party extensions in other frameworks. ### Auth - [`litestar-users`](https://github.com/LonelyVikingMichael/litestar-users) - Authentication and user management for the - Litestar framework. [![Litestar Plugin Architecture](https://img.shields.io/badge/Litestar%20Plugin-%E2%AD%90%20Enabled-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://docs.litestar.dev/latest/usage/plugins.html) + Litestar framework.* ### Databases @@ -152,7 +146,6 @@ that you would normally find as third-party extensions in other frameworks. - [Litestar Docs - Piccolo](https://docs.litestar.dev/latest/usage/databases/piccolo.html) - Documentation on using Piccolo with Litestar. - [Litestar Example](https://github.com/sinisaos/litestar-piccolo) - Using Litestar withPiccolo. - - [`litestar-piccolo`](https://github.com/litestar-org/litestar-piccolo) - A Piccolo ORM adapter for Litestar. #### ODMs @@ -163,7 +156,7 @@ that you would normally find as third-party extensions in other frameworks. ### Monitoring -- [`apitally`](https://github.com/apitally/python-client) - A plugin for easy API monitoring with [Apitally](https://apitally.io/litestar) (including API traffic, errors, response times, payload sizes and uptime). [![Litestar Plugin Architecture](https://img.shields.io/badge/Litestar%20Plugin-%E2%AD%90%20Enabled-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://docs.litestar.dev/latest/usage/plugins.html) +- [`apitally`](https://github.com/apitally/apitally-py ) - A plugin for easy API monitoring with [Apitally](https://apitally.io/litestar) (including API traffic, errors, response times, payload sizes and uptime).* ### Other @@ -192,14 +185,10 @@ that you would normally find as third-party extensions in other frameworks. ### Articles -- [Create a Websocket Chat App](https://blog.litestar.dev/creating-a-websockets-chat-in-just-30-lines-with-litestar-2ca0f3767a47) - - A quick post on creating a websocket chat app with Litestar in 30 lines of code. -- [Creating a universal template (Russian)](https://habr.com/ru/companies/pt/articles/820171/) - - An article about template built on the principles of clean architecture using Litestar, SqlAlchemy, Pydantic, dishka, FastStream +- [Create a Websocket Chat App](https://blog.litestar.dev/creating-a-websockets-chat-in-just-30-lines-with-litestar-2ca0f3767a47) - A quick post on creating a websocket chat app with Litestar in 30 lines of code. +- [Creating a universal template (Russian)](https://habr.com/ru/companies/pt/articles/820171/) - An article about template built on the principles of clean architecture using Litestar, SqlAlchemy, Pydantic, dishka, FastStream. ### Tutorials - -- [**Official** Litestar Tutorial Section](https://docs.litestar.dev/latest/tutorials) - The official Litestar tutorial section. - [Litestar video series by R3ap3rPy](https://www.youtube.com/watch?v=MCWwII_REY8&list=PLIO3UV9ODwNDYJVemuMB-obsUNON0-gpV) ### Talks @@ -266,10 +255,9 @@ that you would normally find as third-party extensions in other frameworks. -- [Litestar, PostgreSQL, Redis, SQLAlchemy](https://github.com/litestar-org/litestar-pg-redis-docker) -- [Litestar, FastStream, dishka, SQLAlchemy](https://github.com/Sehat1137/litestar-dishka-faststream) - [Litestar Fullstack with Vite, VueJS, Redis, PostgreSQL, and more](https://github.com/litestar-org/litestar-fullstack) - Made by [@cofin](https://github.com/cofin/). - [![Deployed on Railway](https://railway.app/button.svg)](https://railway.app/template/KmHMvQ?referralCode=BMcs0x) +- [Litestar, FastStream, dishka, SQLAlchemy](https://github.com/Sehat1137/litestar-dishka-faststream) - [Basic Litestar App](https://github.com/JacobCoffee/litestar-template) - Basic Litestar app with TailwindCSS. - [![Deployed on Railway](https://railway.app/button.svg)](https://railway.app/template/zx1KGh?referralCode=BMcs0x)