Neovim unable to detect Django packages: Getting 'Unable to import 'django.*' error

Question

I've recently configured Neovim for my development workflow, but I'm encountering an issue with Django packages not being detected properly. Whenever I try to import any Django package or use Django functions within Neovim, I receive an error message like this:

Unable to import 'django.conf'

I've ensured that Django is properly installed and working outside of Neovim, but within Neovim, it seems to have trouble locating the Django packages. I've checked my Neovim configuration and paths, but I'm not sure where the problem lies.

Has anyone encountered a similar issue with Neovim and Django packages? How can I troubleshoot and resolve this problem to get Neovim to properly detect Django packages?

Any help or suggestions would be greatly appreciated. Thank you!

Answer 1

The precise answer requires further information on your neovim LSP config and python development environment. Which python LSP server do you use? Do you use a virtual environment?

If you are using a virtual environment, your LSP may not detect the packages installed in that environment. Your LSP must have a way to specify such configuration. For example, if you are using pyright, you can specify above details in 'pyrightconfig.json` file. Here is an example config:

{  
  "venv": "<venv-name>",  
  "venvPath": "<venv-path>/",
  "stubPath": "<project>/src" // path to local packages or modules
}

Check pyright documentation here. You might find following post helpful.