feat: Add project entrypoints

Author: Batalex

pyproject.toml

@@ -1,12 +1,20 @@
-[tool.poetry]
+[project]
 name = "spark8t"
 version = "1.3.1"
 description = "This project provides some utilities function and CLI commands to run Spark on K8s."
-authors = [
-  "Canonical Data Platform <data-platform@lists.launchpad.net>",
-]
+authors = [{ name = "Canonical Processing team" }]
+urls = { contact = "https://matrix.to/#/%23charmhub-analytics%3Aubuntu.com" }
 license = "Apache-2.0"
 readme = "README.md"
+
+[project.scripts]
+pyspark = "spark8t.cli.pyspark:main"
+service-account-registry = "spark8t.cli.service_account_registry:main"
+spark-shell = "spark8t.cli.spark_shell:main"
+spark-sql = "spark8t.cli.spark_sql:main"
+spark-submit = "spark8t.cli.spark_submit:main"
+
+[tool.poetry]
 requires-poetry = ">=2.0.0"
 
 [tool.poetry.requires-plugins]

spark8t/cli/pyspark.py

@@ -23,7 +23,7 @@
 from spark8t.utils import PropertyFile, setup_logging
 
 
-def main(args: Namespace, logger: Logger):
+def entrypoint(args: Namespace, logger: Logger, extra_args: list[str]) -> None:
     """Pyspark main entrypoint."""
     kubeconfig = os.path.expandvars(args.kubeconfig) if args.kubeconfig else None
     context_name = os.path.expandvars(args.context) if args.context else None
@@ -64,7 +64,8 @@ def main(args: Namespace, logger: Logger):
     ).pyspark_shell(confs, properties_file, extra_args)
 
 
-if __name__ == "__main__":
+def main() -> None:
+    """CLI entrypoint."""
     args, extra_args = parse_arguments_with(
         [
             add_logging_arguments,
@@ -78,10 +79,14 @@ def main(args: Namespace, logger: Logger):
     logger = setup_logging(args.log_level, args.log_conf_file, "spark8t.cli.pyspark")
 
     try:
-        main(args, logger)
+        entrypoint(args, logger, extra_args)
         exit(0)
     except (AccountNotFound, PrimaryAccountNotFound) as e:
         logger.error(str(e))
         exit(1)
     except Exception as e:
         raise e
+
+
+if __name__ == "__main__":
+    main()

spark8t/cli/service_account_registry.py

@@ -77,7 +77,7 @@ def create_namespace_if_missing(kube_interface: AbstractKubeInterface, namespace
             raise NamespaceNotFound(namespace) from err
 
 
-def create_service_account_registry_parser(parser: ArgumentParser):
+def create_service_account_registry_parser(parser: ArgumentParser) -> ArgumentParser:
     """Create parser for service account CLI."""
     base_parser = parse_arguments_with(
         [add_logging_arguments, k8s_parser],
@@ -146,7 +146,7 @@ def create_service_account_registry_parser(parser: ArgumentParser):
     return parser
 
 
-def main(args: Namespace, logger: Logger):
+def entrypoint(args: Namespace, logger: Logger) -> None:
     """Service account main entrypoint."""
     kubeconfig = os.path.expandvars(args.kubeconfig) if args.kubeconfig else None
     context_name = os.path.expandvars(args.context) if args.context else None
@@ -255,7 +255,8 @@ def main(args: Namespace, logger: Logger):
             print(print_line)
 
 
-if __name__ == "__main__":
+def main() -> None:
+    """CLI entrypoint."""
     args = create_service_account_registry_parser(
         ArgumentParser(description="Spark Client Setup")
     ).parse_args()
@@ -265,10 +266,14 @@ def main(args: Namespace, logger: Logger):
     )
 
     try:
-        main(args, logger)
+        entrypoint(args, logger)
         exit(0)
     except (AccountNotFound, PrimaryAccountNotFound, ResourceAlreadyExists) as e:
         print(str(e))
         exit(1)
     except Exception as e:
         raise e
+
+
+if __name__ == "__main__":
+    main()

spark8t/cli/spark_shell.py

@@ -23,7 +23,7 @@
 from spark8t.utils import PropertyFile, setup_logging
 
 
-def main(args: Namespace, logger: Logger):
+def entrypoint(args: Namespace, logger: Logger, extra_args: list[str]) -> None:
     """Shell main entrypoint."""
     kubeconfig = os.path.expandvars(args.kubeconfig) if args.kubeconfig else None
     context_name = os.path.expandvars(args.context) if args.context else None
@@ -64,7 +64,8 @@ def main(args: Namespace, logger: Logger):
     ).spark_shell(confs, properties_file, extra_args)
 
 
-if __name__ == "__main__":
+def main() -> None:
+    """CLI entrypoint."""
     args, extra_args = parse_arguments_with(
         [
             add_logging_arguments,
@@ -80,10 +81,14 @@ def main(args: Namespace, logger: Logger):
     )
 
     try:
-        main(args, logger)
+        entrypoint(args, logger, extra_args)
         exit(0)
     except (AccountNotFound, PrimaryAccountNotFound) as e:
         logger.error(str(e))
         exit(1)
     except Exception as e:
         raise e
+
+
+if __name__ == "__main__":
+    main()

spark8t/cli/spark_sql.py

@@ -23,7 +23,7 @@
 from spark8t.utils import PropertyFile, setup_logging
 
 
-def main(args: Namespace, logger: Logger):
+def entrypoint(args: Namespace, logger: Logger, extra_args: list[str]) -> None:
     """Define SQL main entrypoint."""
     kubeconfig = os.path.expandvars(args.kubeconfig) if args.kubeconfig else None
     context_name = os.path.expandvars(args.context) if args.context else None
@@ -63,7 +63,8 @@ def main(args: Namespace, logger: Logger):
     ).spark_sql(confs, properties_file, extra_args)
 
 
-if __name__ == "__main__":
+def main() -> None:
+    """CLI entrypoint."""
     args, extra_args = parse_arguments_with(
         [
             add_logging_arguments,
@@ -77,10 +78,14 @@ def main(args: Namespace, logger: Logger):
     logger = setup_logging(args.log_level, args.log_conf_file, "spark8t.cli.spark_sql")
 
     try:
-        main(args, logger)
+        entrypoint(args, logger, extra_args)
         exit(0)
     except (AccountNotFound, PrimaryAccountNotFound) as e:
         logger.error(str(e))
         exit(1)
     except Exception as e:
         raise e
+
+
+if __name__ == "__main__":
+    main()

spark8t/cli/spark_submit.py

@@ -24,7 +24,7 @@
 from spark8t.utils import PropertyFile, setup_logging
 
 
-def main(args: Namespace, logger: Logger):
+def main_entrypoint(args: Namespace, logger: Logger, extra_args: list[str]) -> None:
     """Submit main entrypoint."""
     # Expand environment variables in arguments
     kubeconfig = os.path.expandvars(args.kubeconfig) if args.kubeconfig else None
@@ -73,7 +73,8 @@ def main(args: Namespace, logger: Logger):
     )
 
 
-if __name__ == "__main__":
+def main() -> None:
+    """CLI entrypoint."""
     args, extra_args = parse_arguments_with(
         [
             add_logging_arguments,
@@ -90,10 +91,14 @@ def main(args: Namespace, logger: Logger):
     )
 
     try:
-        main(args, logger)
+        main_entrypoint(args, logger, extra_args)
         exit(0)
     except (AccountNotFound, PrimaryAccountNotFound) as e:
         logger.error(str(e))
         exit(1)
     except Exception as e:
         raise e
+
+
+if __name__ == "__main__":
+    main()