chore: Add goose providers list command

[elenazherdeva]

[baxen]

LGTM!

[lifeizhou-ap]

I guess you followed the existing implementation pattern.

I am not sure whether lint_providers function is used anywhere else. If it does not, we could move the implementation of lint_providers into this test_linting.py as the implementation is just to check the doc string is correct. I feel it will be easier for people to read and understand

[elenazherdeva]

@lukealvoeiro can describe it better, but the reason behind this is that lint_providers could be used in tests for the goose-plugins-block internal library. Currently, we only have one internal provider, but if there are more in the future, they should follow the same structure. Do you think we should reconsider this logic?

[lukealvoeiro]

Yup, we want this function to be exported so we can lint this in any open source or internal plugin repos as well.

[lifeizhou-ap]

just thinking whether it would be helpful if we list the env vars in the code as a variable or function instead of parsing doc string?

[elenazherdeva]

tbh, I don’t really like this parsing either, but I couldn’t come up with a better approach. Could you elaborate, please? How can we list it as “a variable or function”?

The only idea I have is to add get_required_env function to each provider and call it in main.py

[lamchau]

what do you think if we extend the base provider? we could do the check but the documenting (via mkdocs) would need some playing around with for formatting

here's an example in case i'm not explaining very well 😅

class Provider(ABC):
    REQUIRED_ENV_VARS: list[str] = []

    @classmethod
    def check_env_vars(cls):
       ...

    def __init__(self) -> None:
        self.check_env_vars()

class BedrockProvider(Provider):
    REQUIRED_ENV_VARS = [
        "AWS_ACCESS_KEY_ID",
        "AWS_SECRET_ACCESS_KEY",
        "AWS_SESSION_TOKEN", 
    ]

then to get it into the docs, we could selectively generate it for one constant

::: example.BedrockProvider
    options:
      members:
        - REQUIRED_ENV_VARS

but the formatting isn't the most readable and i'm not sure mkdocstrings gives us control of how to render members. which leaves us with potentially preprocessing to generate the docstring (maybe too complicated)

[lifeizhou-ap]

Hey @elenazherdeva

Thanks for the PR! Looks good! I asked a couple of questions for consideration.

[lifeizhou-ap]

maybe write a test for this function?

[lamchau]

kinda hacky but if the exchange/providers project is visible via the goose distro but might be possible to render this with an os.listdirs()

[lily-de]

Could be a separate PR but could we add functionality to list which of the env vars a user has set or missing? No need to print them, just if they're stored already

[lifeizhou-ap]

Nice!

[lamchau]

:nit: since these are required i think they should be emphasized instead of dim

[lamchau]

looks great! added a couple of minor thoughts :)