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
Copy file name to clipboardExpand all lines: README.md
+74-13Lines changed: 74 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,35 +71,96 @@ See the [Versioning](#versioning) section for details on how this project's vers
71
71
72
72
## Installation
73
73
74
-
The Django Language Server can be installed using your preferred Python package manager.
74
+
The Django Language Server can be installed using your preferred Python package manager or as a standalone binary.
75
75
76
-
For system-wide availability using either `uv` or `pipx`:
76
+
To try the language server without installing using [`uvx`](https://docs.astral.sh/uv/guides/tools/#running-tools):
77
77
78
78
```bash
79
-
uv tool install django-language-server
79
+
uvx --from django-language-server djls serve
80
+
```
81
+
82
+
> [!NOTE]
83
+
> 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.
84
+
85
+
### Install with a package manager (recommended)
86
+
87
+
The language server is published to PyPI with pre-built wheels for the following platforms:
88
+
89
+
-**Linux**: x86_64, aarch64 (both glibc and musl)
90
+
-**macOS**: x86_64, aarch64
91
+
-**Windows**: x64
92
+
-**Source distribution**: Available for other platforms
93
+
94
+
Installing it adds the `djls` command-line tool to your environment.
95
+
96
+
#### System-wide tool installation
80
97
81
-
# or
98
+
Install it globally in an isolated environment using `uv` or `pipx`:
82
99
100
+
```bash
101
+
# Using uv
102
+
uv tool install django-language-server
103
+
104
+
# Or using pipx
83
105
pipx install django-language-server
84
106
```
85
107
86
-
Or to try it out in your current project:
108
+
#### Install with pip
109
+
110
+
Install from PyPI using pip:
111
+
112
+
```bash
113
+
pip install django-language-server
114
+
```
115
+
116
+
Or add as a development dependency with uv:
87
117
88
118
```bash
89
119
uv add --dev django-language-server
90
-
uv sync
120
+
```
91
121
92
-
# or
122
+
### Standalone binaries
93
123
94
-
pip install django-language-server
124
+
Standalone binaries are available for macOS, Linux, and Windows from [GitHub Releases](https://github.com/joshuadavidthomas/django-language-server/releases).
The package provides pre-built wheels with the Rust-based LSP server compiled for common platforms. Installing it adds the `djls` command-line tool to your environment.
140
+
#### Windows
98
141
99
-
> [!NOTE]
100
-
> 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.
101
-
>
102
-
> 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.
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