feat: publish supported python versions in --about

singer_sdk/about.py

@@ -28,6 +28,7 @@ class AboutInfo:
     description: str | None
     version: str
     sdk_version: str
+    supported_python_versions: list[str] | None
 
     capabilities: list[CapabilitiesEnum]
     settings: dict
@@ -88,6 +89,7 @@ def format_about(self, about_info: AboutInfo) -> str:
             Description: {about_info.description}
             Version: {about_info.version}
             SDK Version: {about_info.sdk_version}
+            Supported Python Versions: {about_info.supported_python_versions}
             Capabilities: {about_info.capabilities}
             Settings: {about_info.settings}""",
         )
@@ -116,6 +118,7 @@ def format_about(self, about_info: AboutInfo) -> str:
                 ("description", about_info.description),
                 ("version", about_info.version),
                 ("sdk_version", about_info.sdk_version),
+                ("supported_python_versions", about_info.supported_python_versions),
                 ("capabilities", [c.value for c in about_info.capabilities]),
                 ("settings", about_info.settings),
             ],
@@ -187,6 +190,17 @@ def format_about(self, about_info: AboutInfo) -> str:
             )
             + "\n"
         )
+        setting += "\n"
         md_list.append(setting)
 
+        # Process Supported Python Versions
+
+        if about_info.supported_python_versions:
+            supported_python_versions = "## Supported Python Versions\n\n"
+            supported_python_versions += "\n".join(
+                [f"* {v}" for v in about_info.supported_python_versions],
+            )
+            supported_python_versions += "\n"
+            md_list.append(supported_python_versions)
+
         return "".join(md_list)

singer_sdk/plugin_base.py

@@ -12,6 +12,7 @@
 
 import click
 from jsonschema import Draft7Validator
+from packaging.specifiers import SpecifierSet
 
 from singer_sdk import about, metrics
 from singer_sdk.cli import plugin_cli
@@ -36,6 +37,26 @@
     from singer_sdk.mapper import PluginMapper
 
 SDK_PACKAGE_NAME = "singer_sdk"
+CHECK_SUPPORTED_PYTHON_VERSIONS = (
+    # unsupported versions
+    "2.7",
+    "3.0",
+    "3.1",
+    "3.2",
+    "3.3",
+    "3.4",
+    "3.5",
+    "3.6",
+    "3.7",
+    # current supported versions
+    "3.8",
+    "3.9",
+    "3.10",
+    "3.11",
+    # future supported versions
+    "3.12",
+    "3.13",
+)
 
 
 JSONSchemaValidator = extend_validator_with_defaults(Draft7Validator)
@@ -44,7 +65,10 @@
 class PluginBase(metaclass=abc.ABCMeta):
     """Abstract base class for taps."""
 
-    name: str  # The executable name of the tap or target plugin.
+    name: str  # The executable name of the tap or target plugin. e.g. tap-foo
+    package_name: str | None = (
+        None  # The package name of the plugin. e.g meltanolabs-tap-foo
+    )
 
     config_jsonschema: dict = {}
     # A JSON Schema object defining the config options that this tap will accept.
@@ -171,14 +195,36 @@
             version = "[could not be detected]"
         return version
 
+    @staticmethod
+    def _get_supported_python_versions(package: str) -> list[str] | None:
+        """Return the supported Python versions.
+
+        Args:
+            package: The package name.
+
+        Returns:
+            A list of supported Python versions.
+        """
+        try:
+            supported_python_versions = []
+            package_metadata = metadata.metadata(package)
+            reported_python_versions = SpecifierSet(package_metadata["Requires-Python"])
+            for version in CHECK_SUPPORTED_PYTHON_VERSIONS:
+                if version in reported_python_versions:
+                    supported_python_versions.append(version)
+            return supported_python_versions
+        except metadata.PackageNotFoundError:
+            pass
+        return None
+
     @classmethod
     def get_plugin_version(cls) -> str:
         """Return the package version number.
 
         Returns:
             The package version number.
         """
-        return cls._get_package_version(cls.name)
+        return cls._get_package_version(cls.package_name or cls.name)
 
     @classmethod
     def get_sdk_version(cls) -> str:
@@ -189,6 +235,15 @@
         """
         return cls._get_package_version(SDK_PACKAGE_NAME)
 
+    @classmethod
+    def get_supported_python_versions(cls) -> list[str] | None:
+        """Return the supported Python versions.
+
+        Returns:
+            A list of supported Python versions.
+        """
+        return cls._get_supported_python_versions(cls.package_name or cls.name)
+
     @classproperty
     def plugin_version(cls) -> str:  # noqa: N805
         """Get version.
@@ -325,6 +380,7 @@
             description=cls.__doc__,
             version=cls.get_plugin_version(),
             sdk_version=cls.get_sdk_version(),
+            supported_python_versions=cls.get_supported_python_versions(),
             capabilities=cls.capabilities,
             settings=config_jsonschema,
         )

tests/core/test_about.py

@@ -28,6 +28,7 @@ def about_info() -> AboutInfo:
         description="Example tap for Singer SDK",
         version="0.1.1",
         sdk_version="1.0.0",
+        supported_python_versions=["3.6", "3.7", "3.8"],
         capabilities=[
             TapCapabilities.CATALOG,
             TapCapabilities.DISCOVER,

tests/snapshots/about_format/json.snap.json

@@ -3,6 +3,11 @@
   "description": "Example tap for Singer SDK",
   "version": "0.1.1",
   "sdk_version": "1.0.0",
+  "supported_python_versions": [
+    "3.6",
+    "3.7",
+    "3.8"
+  ],
   "capabilities": [
     "catalog",
     "discover",

tests/snapshots/about_format/markdown.snap.md

@@ -18,3 +18,9 @@ Built with the [Meltano Singer SDK](https://sdk.meltano.com).
 | api_key   | True     | None    | API key for the tap to use. |
 
 A full list of supported settings and capabilities is available by running: `tap-example --about`
+
+## Supported Python Versions
+
+* 3.6
+* 3.7
+* 3.8

tests/snapshots/about_format/text.snap.txt

@@ -2,5 +2,6 @@ Name: tap-example
 Description: Example tap for Singer SDK
 Version: 0.1.1
 SDK Version: 1.0.0
+Supported Python Versions: ['3.6', '3.7', '3.8']
 Capabilities: [catalog, discover, state]
 Settings: {'properties': {'start_date': {'type': 'string', 'format': 'date-time', 'description': 'Start date for the tap to extract data from.'}, 'api_key': {'type': 'string', 'description': 'API key for the tap to use.'}}, 'required': ['api_key']}