Add module docstrings
This commit is contained in:
parent
50b6280e2f
commit
460e74c6bb
@ -1,5 +1,7 @@
|
|||||||
#!/usr/local/env python3
|
#!/usr/local/env python3
|
||||||
|
|
||||||
|
"""MODULE: Provides CLI arguments to the application."""
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
|
|
||||||
from app.query_normalisation import get_public_ip
|
from app.query_normalisation import get_public_ip
|
||||||
|
@ -1,5 +1,7 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
"""MODULE: Provides functions to call various APIs to retrieve IP/prefix information."""
|
||||||
|
|
||||||
import ipaddress
|
import ipaddress
|
||||||
import requests
|
import requests
|
||||||
|
|
||||||
|
@ -1,5 +1,7 @@
|
|||||||
#!/usr/local/bin/python3
|
#!/usr/local/bin/python3
|
||||||
|
|
||||||
|
"""MODULE: Main application module."""
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from app.args import parse_args
|
from app.args import parse_args
|
||||||
|
@ -1,5 +1,7 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
"""MODULE: Provides functions for preparing, then printing, retrieved data."""
|
||||||
|
|
||||||
from tabulate import tabulate
|
from tabulate import tabulate
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,5 +1,7 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
"""MODULE: Provides functions that ensure an IP address is available to query the APIs for."""
|
||||||
|
|
||||||
import socket
|
import socket
|
||||||
import ipaddress
|
import ipaddress
|
||||||
import requests
|
import requests
|
||||||
|
@ -1,5 +1,7 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
"""MODULE: Provides test cases for app/ip_info.py."""
|
||||||
|
|
||||||
from app.ip_info import ( # pragma: no cover
|
from app.ip_info import ( # pragma: no cover
|
||||||
get_ip_information,
|
get_ip_information,
|
||||||
get_autonomous_system_number,
|
get_autonomous_system_number,
|
||||||
|
@ -1,5 +1,7 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
"""MODULE: Provides test cases for app/main.py."""
|
||||||
|
|
||||||
# from app.ip import is_ip_address
|
# from app.ip import is_ip_address
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,5 +1,7 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
"""MODULE: Provides test cases for app/query_normalisation.py."""
|
||||||
|
|
||||||
from app.query_normalisation import ( # pragma: no cover
|
from app.query_normalisation import ( # pragma: no cover
|
||||||
is_ip_address,
|
is_ip_address,
|
||||||
resolve_domain_name,
|
resolve_domain_name,
|
||||||
|
Loading…
x
Reference in New Issue
Block a user