Playwright integration for Litestar.

• litestar-playwright
  • Table of Contents
  • Features
  • Installation
  • Usage
  • Simple Example
  • Multiple Playwright Plugins Example
  • Support ✉️
  • Author 👑
  • Contributing
  • Tasks
    • install
    • style
    • ci
    • run-simple
    • run-multiple-plugins
  • License
  • Changelog 📝

litestar-playwright is a plugin for Litestar that provides Playwright integration.

✨ This project was born out of necessity when I was working on a project that required me to take screenshots 📸of given HTML content. I was using Playwright for this purpose, but I was not satisfied with my workflow. While improving the workflow, I started a discussion 💬 at the Litestar Organization. Even though the discussion had zero activity 💤, it was a great opportunity to discover some of the internal mechanisms of Litestar. After over-engineering the workflow 🤓, I decided to create a plugin for Litestar that would provide seamless Playwright integration. I learned a lot about how to use Playwright with Litestar on the way 🚀.

• 🎭 Browser Management: Manage Playwright browser instances
• 🔧 Dependency Injection: Automatic injection of browser instances into route handlers
• ⚡ Async Support: Full async/await support for all operations

uv add litestar-playwright

Check out the Quick Start example to see how to use the plugin.

Check out the Multiple Playwright Plugins example to see how to use multiple plugins in a single application.

If you have any questions or need help, feel free to open an issue on the GitHub repository.

Any contributions are welcome! Please follow the Contributing Guidelines to contribute to this project.

This project is maintained by Hasan Sezer Taşan, It's me 👋

Clone the repository and cd into the project directory:

git clone https://github.com/hasansezertasan/litestar-playwright
cd litestar-playwright

The commands below can also be executed using the xc task runner, which combines the usage instructions with the actual commands. Simply run xc, it will pop up an interactive menu with all available tasks.

Install the dependencies:

uv sync
uv run playwright install

Run the style checks:

uv run --locked tox run -e style

Run the CI pipeline:

uv run --locked tox run

Run the simple example:

uv run python examples/simple.py

Run the multiple plugins example:

uv run python examples/multiple_plugins.py

litestar-playwright is distributed under the terms of the MIT license.

For a detailed list of changes, please refer to the CHANGELOG.