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
Improves organization and flow of installation instructions based on
logical grouping and user needs.
Changes:
- Move pre-built wheels info into package manager section where it's relevant
- Move environment detection note to system-wide tool section where it's most helpful
- Add proper PowerShell commands to Windows binary installation for parity with Linux/macOS
- Move cargo build from source to end as the most advanced option
- Remove redundant pre-built wheels section at the end
Copy file name to clipboardExpand all lines: README.md
+29-22Lines changed: 29 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,7 +75,14 @@ The Django Language Server can be installed using your preferred Python package
75
75
76
76
### Install with a package manager (recommended)
77
77
78
-
The language server is published to PyPI with pre-built wheels for common platforms. Installing it adds the `djls` command-line tool to your environment.
78
+
The language server is published to PyPI with pre-built wheels for the following platforms:
79
+
80
+
-**Linux**: x86_64, aarch64 (both glibc and musl)
81
+
-**macOS**: x86_64, aarch64
82
+
-**Windows**: x64
83
+
-**Source distribution**: Available for other platforms
84
+
85
+
Installing it adds the `djls` command-line tool to your environment.
> 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
+
98
108
#### Install with pip
99
109
100
110
Install from PyPI using pip:
@@ -109,16 +119,6 @@ Or add as a development dependency with uv:
109
119
uv add --dev django-language-server
110
120
```
111
121
112
-
#### Install from source with cargo
113
-
114
-
Build and install directly from source using Rust's cargo:
This requires a Rust toolchain (see [rust-toolchain.toml](rust-toolchain.toml) for the required version) and will compile the language server from source.
121
-
122
122
### Standalone binaries
123
123
124
124
Standalone binaries are available for macOS, Linux, and Windows from [GitHub Releases](https://github.com/joshuadavidthomas/django-language-server/releases).
Download the `.zip` file for Windows from the [releases page](https://github.com/joshuadavidthomas/django-language-server/releases), extract it, and add the directory containing `djls.exe` to your PATH.
-**Source distribution**: Available for other platforms
163
+
### Install from source with cargo
160
164
161
-
> [!NOTE]
162
-
> 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.
163
-
>
164
-
> It's recommended to use `uv` or `pipx` to install it system-wide for convenience, but installing in your project's environment will work just as well to give it a test drive around the block.
165
+
Build and install directly from source using Rust's cargo:
This requires a Rust toolchain (see [rust-toolchain.toml](rust-toolchain.toml) for the required version) and will compile the language server from source.
0 commit comments