Skip to content

docs: fix incorrect uv configuration for CLI extensions in "Using entry points" section (#4455)#4456

Merged
provinzkraut merged 4 commits intolitestar-org:mainfrom
GavinAstk:main
Jan 7, 2026
Merged

docs: fix incorrect uv configuration for CLI extensions in "Using entry points" section (#4455)#4456
provinzkraut merged 4 commits intolitestar-org:mainfrom
GavinAstk:main

Conversation

@GavinAstk
Copy link
Copy Markdown
Contributor

Description

Fix incorrect uv package manager configuration in CLI extension documentation. The current documentation uses [project.scripts] which creates standalone executables instead of registering commands with the Litestar CLI group.

Changes Made

  • Replaced [project.scripts] configuration with correct [project.entry-points."litestar.commands"] in CLI extension examples
  • Updated documentation to align with Litestar source code that searches for litestar.commands entry point group
  • Ensured compatibility with uv and other PEP 621 compliant package managers

Closes

close #4455

@github-actions
Copy link
Copy Markdown

github-actions bot commented Nov 2, 2025

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/4456

Copy link
Copy Markdown
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just above the changed like we have tool.poetry.plugins, which is deprecated: https://python-poetry.org/docs/pyproject#plugins

Can you please update it as well?

Copy link
Copy Markdown
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@GavinAstk
Copy link
Copy Markdown
Contributor Author

@sobolevn Thanks for pointing that out! I've updated the deprecated tool.poetry.plugins configuration to use the standard [project.entry-points] format as requested. The changes are now included in this PR.

@provinzkraut provinzkraut disabled auto-merge January 7, 2026 11:40
@provinzkraut provinzkraut merged commit 7a63503 into litestar-org:main Jan 7, 2026
27 checks passed
provinzkraut added a commit that referenced this pull request Jan 25, 2026
…ntry points" section (#4455) (#4456)

* docs: fix incorrect `uv` configuration for CLI extensions in "Using entry points" section (#4455)

* docs: Replace deprecated `tool.poetry.plugins` with standard `[project.entry-points]` for CLI command registration to ensure PEP 621 compliance. (#4455)

---------

Co-authored-by: Janek Nouvertné <provinzkraut@posteo.de>
(cherry picked from commit 7a63503)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs This PR involves changes to the documentation pr/external pr/internal size: small Triage Required 🏥 This requires triage type/docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Incorrect uv configuration for CLI extensions in "Using entry points" section

3 participants