django-language-server

PyPI - Python Version

A language server for the Django web framework.

[!CAUTION] This project is in early stages. ~~All~~ Most features are incomplete and missing.

Features

[x] Completions - Template tag autocompletion with snippets
[x] Diagnostics - Real-time error checking and validation
[ ] Go to definition - Jump to template, block, or variable definitions
[ ] Find references - See where templates and blocks are used
[ ] Hover - View documentation and type info on hover
[ ] Rename - Refactor names across files
[ ] Formatting - Auto-format templates
[ ] Code actions - Quick fixes and refactorings
[ ] Document symbols - Outline view of template structure
[ ] Workspace symbols - Search across all project templates
[ ] Signature help - Parameter hints while typing

Getting Started

Set up your editor's LSP client to run the server:

VS Code - Install the extension from the marketplace
Neovim - Configure with vim.lsp.config()
Sublime Text - Set up with LSP package
Zed - Install the extension

See all client configurations.

Most editors can use uvx --from django-language-server djls serve to run the server on-demand without installing it. Alternatively, install it globally first:

uv tool install django-language-server
# or: pipx install django-language-server

See the Installation guide for more options including pip, standalone binaries, and building from source.

Once configured, open any Django template file in your project to get:

Template tag completions with snippets
Real-time syntax validation and diagnostics
Navigation to template definitions and references

Documentation

Visit djls.joshthomas.dev for full documentation including installation guides, configuration options, and editor setup instructions.

License

django-language-server is licensed under the Apache License, Version 2.0. See the LICENSE file for more information.

django-language-server is not associated with the Django Software Foundation.

Django is a registered trademark of the Django Software Foundation.