feat(api): Added Host Diff API (#235)

* feat(api): Host Diff API
* chore(typing): Update typing for tests
* chore(deps): Upgrade rich
* chore(api): Enhance multithreaded API calls
* fix(deps): Correct importlib-metadata versions
* chore(docs): Add host diff example
* chore(cli): Improve error handling and tests
* chore(docs): Improve usage
* fix(cli): Properly handle CLI errors
* feat(dev-deps): Add blacken-docs
* chore(dev-deps): Add pyupgrade
* feat(cli): Improved config options
* chore(deps): Update packages
* chore: Remove extra whitespace
* chore(ci): Show missing coverage
* fix(test): Increase config coverage

Author: thehappydinoa

.coveragerc

@@ -1,3 +1,6 @@
 [run]
-include = 
+include =
     censys/*
+
+[report]
+show_missing = true

.flake8

@@ -1,6 +1,6 @@
 [flake8]
 max-line-length = 88
-exclude = 
+exclude =
     docs,
     .venv,
     # No need to traverse our git directory
@@ -11,7 +11,7 @@ exclude =
     build,
     # This contains builds of flake8 that we don't want to check
     dist
-per-file-ignores = 
+per-file-ignores =
     tests/*.py:E501,D100,D101,D102,D103,D104,D107,
     __init__.py:F401,F403,
     censys/search/v2/certs.py:DAR101

.gitignore

@@ -75,6 +75,11 @@ dmypy.json
 
 # IDE
 .vscode/
+.idea/
+
+# Config
+*.cfg
+.pre-commit-config.yaml
 
 # Output
 censys-query-output.*

README.md

@@ -68,6 +68,7 @@ Successfully authenticated
 - [Documentation](https://censys-python.rtfd.io)
 - [Discussions](https://github.com/censys/censys-python/discussions)
 - [Censys Homepage](https://censys.io/)
+- [Censys Search](https://search.censys.io/)
 
 ## Contributing
 

censys/cli/__init__.py

@@ -19,9 +19,6 @@ def main():
 
     try:
         args.func(args)
-    except AttributeError:
-        parser.print_help()
-        parser.exit()
     except KeyboardInterrupt:  # pragma: no cover
         sys.exit(1)
 

censys/cli/args.py

@@ -46,7 +46,13 @@ def get_parser() -> argparse.ArgumentParser:
         default=False,
         help="display version",
     )
-    parser.set_defaults()
+
+    def print_help(_: argparse.Namespace):
+        """Prints help."""
+        parser.print_help()
+        parser.exit()
+
+    parser.set_defaults(func=print_help)
 
     subparsers = parser.add_subparsers()
 

censys/cli/commands/__init__.py

@@ -1,4 +1,4 @@
 """Censys CLI commands."""
 from . import account, asm, config, hnri, search, view
 
-__all__ = ["asm", "config", "hnri", "search", "view", "account"]
+__all__ = ["account", "asm", "config", "hnri", "search", "view"]

censys/cli/commands/asm.py

@@ -60,7 +60,7 @@ def cli_add_seeds(args: argparse.Namespace):
         if args.input_file == "-":
             data = sys.stdin.read()
         else:
-            with open(args.input_file, "r") as f:
+            with open(args.input_file) as f:
                 data = f.read()
     else:
         data = args.json

censys/cli/commands/config.py

@@ -60,17 +60,24 @@ def cli_config(_: argparse.Namespace):  # pragma: no cover
         client = CensysSearchAPIv2(api_id, api_secret)
         account = client.account()
         email = account.get("email")
+        console.print(f"\nSuccessfully authenticated for {email}")
 
         # Assumes that login was successfully
         config.set(DEFAULT, "api_id", api_id)
         config.set(DEFAULT, "api_secret", api_secret)
 
         write_config(config)
-        console.print(f"\nSuccessfully authenticated for {email}")
         sys.exit(0)
     except CensysUnauthorizedException:
         console.print("Failed to authenticate")
         sys.exit(1)
+    except PermissionError as e:
+        console.print(e)
+        console.print(
+            "Cannot write config file to directory. "
+            + "Please set the `CENSYS_CONFIG_PATH` environmental variable to a writeable location."
+        )
+        sys.exit(1)
 
 
 def include(parent_parser: argparse._SubParsersAction, parents: dict):

censys/cli/commands/hnri.py

@@ -166,6 +166,7 @@ def include(parent_parser: argparse._SubParsersAction, parents: dict):
         parents=[parents["auth"]],
     )
     hnri_parser.add_argument(
+        "-O",
         "--open",
         action="store_true",
         help="open your IP in browser",