update.sh: Unable to import plugin netbox_topology_views: Module not found

[larsen0815]

Hi,

I just recently installed NetBox 4.3.0 via git and added the plugin netbox-topology-views 4.2.1 and everything was running fine.

Now, I want to upgrade NetBox to 4.3.1 but get this error:

Skipping local dependencies (local_requirements.txt not found)
Applying database migrations (python3 netbox/manage.py migrate)...
Traceback (most recent call last):
  File "/opt/netbox/netbox/netbox/settings.py", line 825, in <module>
    plugin = importlib.import_module(plugin_name)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1142, in _find_and_load_unlocked
ModuleNotFoundError: No module named 'netbox_topology_views'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/opt/netbox/netbox/manage.py", line 10, in <module>
    execute_from_command_line(sys.argv)
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/core/management/__init__.py", line 442, in execute_from_command_line
    utility.execute()
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/core/management/__init__.py", line 436, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/core/management/base.py", line 408, in run_from_argv
    parser = self.create_parser(argv[0], argv[1])
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/core/management/base.py", line 371, in create_parser
    self.add_arguments(parser)
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/core/management/commands/migrate.py", line 45, in add_arguments
    choices=tuple(connections),
            ^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/utils/connection.py", line 73, in __iter__
    return iter(self.settings)
                ^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/utils/functional.py", line 47, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
                                         ^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/utils/connection.py", line 45, in settings
    self._settings = self.configure_settings(self._settings)
                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/db/utils.py", line 148, in configure_settings
    databases = super().configure_settings(databases)
                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/utils/connection.py", line 50, in configure_settings
    settings = getattr(django_settings, self.settings_name)
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/conf/__init__.py", line 81, in __getattr__
    self._setup(name)
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/conf/__init__.py", line 68, in _setup
    self._wrapped = Settings(settings_module)
                    ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/netbox/venv/lib/python3.11/site-packages/django/conf/__init__.py", line 166, in __init__
    mod = importlib.import_module(self.SETTINGS_MODULE)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1149, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 690, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 940, in exec_module
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "/opt/netbox/netbox/netbox/settings.py", line 828, in <module>
    raise ImproperlyConfigured(
django.core.exceptions.ImproperlyConfigured: Unable to import plugin netbox_topology_views: Module not found. Check that the plugin module has been installed within the correct Python environment.

local_requirements.txt not found is strange, cause the file exists:

# ll /opt/netbox/netbox/local_requirements.txt
-rw-r--r-- 1 root root 22 May 14 10:32 /opt/netbox/netbox/local_requirements.txt

# cat /opt/netbox/netbox/local_requirements.txt
netbox-topology-views

# grep "PLUGINS =" /opt/netbox/netbox/netbox/configuration.py
PLUGINS = ["netbox_topology_views"]

btw: Strange to have the plugin name in one file with dashes, and in the other file with underscores, but this is according to the docs (and changing it, didn't seem to make a difference).

What is causing the problem?

Python version: 3.11.2
NetBox version: 4.3.0
Plugins:
netbox_topology_views: 4.2.1

[pheus]

Hi,

the problem is that your local_requirements.txt file is in the wrong directory. It needs to be placed in the root of the NetBox installation path — for example, /opt/netbox — not inside /opt/netbox/netbox.

This is why the upgrade process is skipping it, even though the file exists.

---

Side note: The netbox-topology-views plugin is not yet tested or confirmed compatible with NetBox v4.3.x. As stated in the plugin's documentation:

"If the version of NetBox is not listed here the plugin will most likely not work. Remove the plugin if you want to update NetBox before this plugin has released an update for that NetBox version."
(source: README.md of the plugin)

So it's recommended to either wait for an official plugin update or remove the plugin before upgrading NetBox.

Hope this helps!

[larsen0815]

Thanks, that was it. I will create a PR to improve the plugin's installation instructions even more so this won't happen to other users.

I didn't pay attention to the compatibility before, but actually ntv 4.2.1 ist stated to be compatible with "4.3.X".

[pheus]

Hi,

Great to hear that solved it!

FYI, the compatibility table was updated about 2 hours ago to show that netbox-topology-views 4.2.1 is indeed compatible with NetBox “4.3.x” 😅. Still, any improvements to the installation instructions are always welcome—thanks for putting together a PR!

Cheers!