Skip to content

Commit 81298b4

Browse files
authored
docs: add uv examples to the docs (#4189)
1 parent f12580b commit 81298b4

File tree

2 files changed

+23
-8
lines changed

2 files changed

+23
-8
lines changed

docs/usage/cli.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,14 +116,22 @@ entries should point to a :class:`click.Command` or :class:`click.Group`:
116116
[project.entry-points."litestar.commands"]
117117
my_command = "my_litestar_plugin.cli:main"
118118
119-
.. tab-item:: Poetry
119+
.. tab-item:: poetry
120120

121121
.. code-block:: toml
122-
:caption: Using `Poetry <https://python-poetry.org/>`_
122+
:caption: Using `poetry <https://python-poetry.org/>`_
123123
124124
[tool.poetry.plugins."litestar.commands"]
125125
my_command = "my_litestar_plugin.cli:main"
126126
127+
.. tab-item:: uv
128+
129+
.. code-block:: toml
130+
:caption: Using `uv <https://docs.astral.sh/uv/>`_
131+
132+
[project.scripts]
133+
my_command = "my_litestar_plugin.cli:main"
134+
127135
Using a plugin
128136
^^^^^^^^^^^^^^
129137

docs/usage/testing.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -184,28 +184,35 @@ across requests, then you might want to inject or inspect session data outside a
184184
.. code-block:: bash
185185
:caption: Using pip
186186
187-
python3 -m pip install litestar[cryptography]
187+
python3 -m pip install 'litestar[cryptography]'
188188
189189
.. tab-item:: pipx
190190

191191
.. code-block:: bash
192192
:caption: Using `pipx <https://pypa.github.io/pipx/>`_
193193
194-
pipx install litestar[cryptography]
194+
pipx install 'litestar[cryptography]'
195195
196196
.. tab-item:: pdm
197197

198198
.. code-block:: bash
199199
:caption: Using `PDM <https://pdm.fming.dev/>`_
200200
201-
pdm add litestar[cryptography]
201+
pdm add 'litestar[cryptography]'
202202
203-
.. tab-item:: Poetry
203+
.. tab-item:: poetry
204204

205205
.. code-block:: bash
206-
:caption: Using `Poetry <https://python-poetry.org/>`_
206+
:caption: Using `poetry <https://python-poetry.org/>`_
207207
208-
poetry add litestar[cryptography]
208+
poetry add 'litestar[cryptography]'
209+
210+
.. tab-item:: uv
211+
212+
.. code-block:: bash
213+
:caption: Using `uv <https://docs.astral.sh/uv/>`_
214+
215+
uv add 'litestar[cryptography]'
209216
210217
.. tab-set::
211218

0 commit comments

Comments
 (0)