You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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)
Copy file name to clipboardExpand all lines: README.md
+14-10Lines changed: 14 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,6 +73,16 @@ See the [Versioning](#versioning) section for details on how this project's vers
73
73
74
74
The Django Language Server can be installed using your preferred Python package manager or as a standalone binary.
75
75
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
+
76
86
### Install with a package manager (recommended)
77
87
78
88
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
84
94
85
95
Installing it adds the `djls` command-line tool to your environment.
86
96
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.
90
99
91
-
```bash
92
-
uvx django-language-server
93
-
```
100
+
#### System-wide tool installation
94
101
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`:
> 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.
0 commit comments