Add kafka-python cli script to wrap admin/consumer/producer (#3034)

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

Author: dpkp

kafka/cli/__init__.py

@@ -0,0 +1,36 @@
+import sys
+
+USAGE = """\
+usage: kafka-python {admin,consumer,producer} [options]
+
+Top-level entry point for the kafka-python command-line tools.
+
+  kafka-python admin     -- administrative client (topics, configs, groups, ...)
+  kafka-python consumer  -- console consumer
+  kafka-python producer  -- console producer
+
+Run `kafka-python <subcommand> --help` for subcommand-specific options.
+"""
+
+
+def run_cli(args=None):
+    if args is None:
+        args = sys.argv[1:]
+
+    if not args or args[0] in ('-h', '--help'):
+        sys.stdout.write(USAGE)
+        return 0 if args else 1
+
+    sub, rest = args[0], args[1:]
+    if sub == 'admin':
+        from kafka.cli.admin import run_cli as sub_run
+    elif sub == 'consumer':
+        from kafka.cli.consumer import run_cli as sub_run
+    elif sub == 'producer':
+        from kafka.cli.producer import run_cli as sub_run
+    else:
+        sys.stderr.write('kafka-python: unknown subcommand: %r\n' % sub)
+        sys.stderr.write(USAGE)
+        return 2
+
+    return sub_run(rest, prog='kafka-python %s' % sub)

kafka/cli/admin/__init__.py

@@ -15,9 +15,9 @@
 from kafka.errors import BrokerResponseError
 
 
-def build_parser(groups=()):
+def build_parser(groups=(), prog=None):
     parser = argparse.ArgumentParser(
-        prog='python -m kafka.admin',
+        prog=prog or 'python -m kafka.admin',
         description='Kafka Admin Client',
     )
     add_common_cli_args(parser, bootstrap_required=False)
@@ -37,12 +37,12 @@ def build_parser(groups=()):
     return parser
 
 
-def run_cli(args=None):
+def run_cli(args=None, prog=None):
     parser = build_parser([
         ACLsCommandGroup, ClusterCommandGroup, ConfigsCommandGroup,
         TopicsCommandGroup, PartitionsCommandGroup, GroupsCommandGroup,
         UsersCommandGroup,
-    ])
+    ], prog=prog)
     config = parser.parse_args(args)
     if not config.group:
         parser.print_help()

kafka/cli/consumer/__init__.py

@@ -6,9 +6,9 @@
 from ..common import add_common_cli_args, configure_logging, build_connect_kwargs
 
 
-def main_parser():
+def main_parser(prog=None):
     parser = argparse.ArgumentParser(
-        prog='python -m kafka.consumer',
+        prog=prog or 'python -m kafka.consumer',
         description='Kafka console consumer',
     )
     add_common_cli_args(parser)
@@ -30,8 +30,8 @@ def main_parser():
     return parser
 
 
-def run_cli(args=None):
-    parser = main_parser()
+def run_cli(args=None, prog=None):
+    parser = main_parser(prog=prog)
     config = parser.parse_args(args)
 
     if config.format not in ('str', 'raw', 'full'):

kafka/cli/producer/__init__.py

@@ -6,9 +6,9 @@
 from ..common import add_common_cli_args, configure_logging, build_connect_kwargs
 
 
-def main_parser():
+def main_parser(prog=None):
     parser = argparse.ArgumentParser(
-        prog='python -m kafka.producer',
+        prog=prog or 'python -m kafka.producer',
         description='Kafka console producer',
     )
     add_common_cli_args(parser)
@@ -22,8 +22,8 @@ def main_parser():
     return parser
 
 
-def run_cli(args=None):
-    parser = main_parser()
+def run_cli(args=None, prog=None):
+    parser = main_parser(prog=prog)
     config = parser.parse_args(args)
 
     configure_logging(config)

pyproject.toml

@@ -36,6 +36,9 @@ Repository = "https://github.com/dpkp/kafka-python"
 Issues = "https://github.com/dpkp/kafka-python/issues"
 Changelog = "https://github.com/dpkp/kafka-python/blob/master/CHANGES.md"
 
+[project.scripts]
+kafka-python = "kafka.cli:run_cli"
+
 [project.optional-dependencies]
 crc32c = ["crc32c"]
 lz4 = ["lz4"]