Add a docstring to "bootstrap_django"

Uninett · May 23, 2023 · 10aad78 · 10aad78
1 parent 87957ad
commit 10aad78
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/python/nav/bootstrap.py b/python/nav/bootstrap.py
@@ -29,6 +29,14 @@
 
 
 def bootstrap_django(caller=None):
+    """
+    Set up django (especially important: the database connection)
+
+    This is necessary when having standalone Python scripts that use the
+    database via the Django model definitions. NAV is older than Django, the
+    Django native way is to use management-commands. The Django "manage.py"
+    script essentially does this before it runs a command.
+    """
     global RUN
 
     if 'DJANGO_SETTINGS_MODULE' not in os.environ: