How to organize shared code in NetBox custom scripts

[krasotinpa]

Hi all,

A similar question may have been asked before, but I wanted to clarify in our context.

We have built up a large library of custom scripts for NetBox, which we load from our Git repository. We would like to refactor the repeating code into a shared module (e.g., my_utils.py).

Question: Is it possible to store and import such a utility module from the same Git repository where the custom scripts are stored?

My attempt: I tried creating a my_utils.py file (without a Script class) in the repo, but without success.
my_utils.py does not appear in the script directory and script fails on import.

Could you please advise on the correct approach or structure for shared code in NetBox custom scripts?

Thank you in advance.

[krasotinpa]

Hi -

I've found one ugly hack to load module with my utilities from git to scripts dir.

1. Create file with any dummy script, put utils in it. Ex my_utils.py;

from extras.scripts import Script


class DummyScript(Script):
    class Meta:
        name = "Dummy script to load utils"
        description = "It exists only to load utils"
        commit_default = False
        scheduling_enabled = False

def my_cool_util: 
    pass

2. Import my unil from my_utils.py:

from scripts.my_utils import my_cool_util

...

3. Sync data source and add DummyScript

4. Success.

[markkuleinio]

I'd try putting it in /opt/netbox/netbox/local/my_utils.py, then

from local.my_utils import my_cool_util

my_cool_util()

/opt/netbox/netbox/local is excluded in NetBox' .gitignore, so it doesn't conflict with the git repo.