app/args.py

@@ -1,5 +1,7 @@
 #!/usr/local/env python3
 
+"""MODULE: Provides CLI arguments to the application."""
+
 import argparse
 
 from app.query_normalisation import get_public_ip

app/ip_info.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 
+"""MODULE: Provides functions to call various APIs to retrieve IP/prefix information."""
+
 import ipaddress
 import requests
 

app/main.py

@@ -1,5 +1,7 @@
 #!/usr/local/bin/python3
 
+"""MODULE: Main application module."""
+
 import sys
 
 from app.args import parse_args

app/print_table.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 
+"""MODULE: Provides functions for preparing, then printing, retrieved data."""
+
 from tabulate import tabulate
 
 

app/query_normalisation.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 
+"""MODULE: Provides functions that ensure an IP address is available to query the APIs for."""
+
 import socket
 import ipaddress
 import requests

tests/test_ip_info.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 
+"""MODULE: Provides test cases for app/ip_info.py."""
+
 from app.ip_info import (  # pragma: no cover
     get_ip_information,
     get_autonomous_system_number,

tests/test_main.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 
+"""MODULE: Provides test cases for app/main.py."""
+
 # from app.ip import is_ip_address
 
 

tests/test_query_normalisation.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 
+"""MODULE: Provides test cases for app/query_normalisation.py."""
+
 from app.query_normalisation import (  # pragma: no cover
     is_ip_address,
     resolve_domain_name,