Add more help in the singer template

[cgardens]

Singer Template Currently produces this:

class SourceGoogleAdwordsSinger(SingerSource):
    def __init__(self):
        super().__init__()

    def check(self, logger: AirbyteLogger, config_container: ConfigContainer) -> AirbyteConnectionStatus:
        raise Exception("unimplemented")

    def discover_cmd(self, logger: AirbyteLogger, config_path: str) -> str:
        # discover the schema with the provided config
        raise Exception("unimplemented")

    def read_cmd(self, logger: AirbyteLogger, config_path: str, catalog_path: str, state_path: str = None) -> str:
        raise Exception("unimplemented")

But there's a bunch more boilerplate that we do the same each time. It's much faster to get to a correct state to copy and paste an existing integration's source.py than it is to use the generated by the template.

e.g. of existing

class SourceGithubSinger(SingerSource):
    def __init__(self):
        pass

    def check(self, logger, config_container) -> AirbyteConnectionStatus:
        try:
            json_config = config_container.rendered_config
            r = requests.get("https://api.github.com/repos/airbytehq/airbyte/commits", auth=(json_config["access_token"], ""))
            if r.status_code == 200:
                return AirbyteConnectionStatus(status=Status.SUCCEEDED)
            else:
                return AirbyteConnectionStatus(status=Status.FAILED, message=r.text)
        except Exception as e:
            return AirbyteConnectionStatus(status=Status.FAILED, message=f"{str(e)}")

    def discover_cmd(self, logger, config_path) -> str:
        return f"tap-github --config {config_path} --discover"

    def read_cmd(self, logger, config_path, catalog_path, state_path=None) -> str:
        config_option = f"--config {config_path}"
        properties_option = f"--properties {catalog_path}"
        state_option = f"--state {state_path}" if state_path else ""
        return f"tap-github {config_option} {properties_option} {state_option}"

[ChristopheDuong]

I think that's what is being introduced by the BaseSingerSource class

airbyte/airbyte-integrations/bases/base-singer/base_singer/source.py

Line 148 in 21c2993

class BaseSingerSource(SingerSource):

@sherifnada was saying this is the transitioning state to that new abstraction

[cgardens]

agreed. i think we can call this closed.