Skip to content

Commit b81d5a5

Browse files
committed
Move uvx to dedicated try it out section
Creates a separate "Try it out" section at the top of installation instructions for uvx, making it clear this is the easiest way to test the language server before committing to an installation. Changes: - Create new "Try it out" section as first subsection under Installation - Move uvx command out of system-wide tool installation - Add explanatory text about ephemeral execution - Keep system-wide installation focused on persistent installs (uv/pipx)
1 parent d9de292 commit b81d5a5

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,16 @@ See the [Versioning](#versioning) section for details on how this project's vers
7373

7474
The Django Language Server can be installed using your preferred Python package manager or as a standalone binary.
7575

76+
### Try it out
77+
78+
Try the language server without installing using `uvx`:
79+
80+
```bash
81+
uvx django-language-server
82+
```
83+
84+
This will run the language server without installing it, perfect for testing it out first.
85+
7686
### Install with a package manager (recommended)
7787

7888
The language server is published to PyPI with pre-built wheels for the following platforms:
@@ -84,15 +94,12 @@ The language server is published to PyPI with pre-built wheels for the following
8494

8595
Installing it adds the `djls` command-line tool to your environment.
8696

87-
#### System-wide tool installation
88-
89-
Try the language server without installing using `uvx`:
97+
> [!NOTE]
98+
> The server will automatically detect and use your project's Python environment when you open a Django project. It needs access to your project's Django installation and other dependencies, but should be able to find these regardless of where the server itself is installed.
9099
91-
```bash
92-
uvx django-language-server
93-
```
100+
#### System-wide tool installation
94101

95-
Or install it globally in an isolated environment using `uv` or `pipx`:
102+
Install it globally in an isolated environment using `uv` or `pipx`:
96103

97104
```bash
98105
# Using uv
@@ -102,9 +109,6 @@ uv tool install django-language-server
102109
pipx install django-language-server
103110
```
104111

105-
> [!NOTE]
106-
> The server will automatically detect and use your project's Python environment when you open a Django project. It needs access to your project's Django installation and other dependencies, but should be able to find these regardless of where the server itself is installed.
107-
108112
#### Install with pip
109113

110114
Install from PyPI using pip:

0 commit comments

Comments
 (0)