italia / eudi-wallet-it-python

Python toolchain for building an OpenID4VP RP with a SATOSA backend compliant with the Italian Wallet implementation profile
Apache License 2.0
17 stars 13 forks source link

Classes and functions docstrings #195

Closed peppelinux closed 8 months ago

peppelinux commented 10 months ago

We need to document each class, method and function with a structure similar to what we have for the backend class

"""
        OpenID4VP backend module.
        :param auth_callback_func: Callback should be called by the module after the authorization
        in the backend is done.
        :param internal_attributes: Mapping dictionary between SATOSA internal attribute names and
        the names returned by underlying IdP's/OP's as well as what attributes the calling SP's and
        RP's expects namevice.
        :param config: Configuration parameters for the module.
        :param base_url: base url of the service
        :param name: name of the plugin
        :type auth_callback_func:
        (satosa.context.Context, satosa.internal.InternalData) -> satosa.response.Response
        :type internal_attributes: dict[string, dict[str, str | list[str]]]
        :type config: dict[str, dict[str, str] | list[str]]
        :type base_url: str
        :type name: str
        """
peppelinux commented 10 months ago

Then extract and create the API documentation here https://github.com/italia/eudi-wallet-it-python#usage

davidelongo-ey commented 10 months ago

More info about task WiP:

using docstring rst format:

@PascalDR

peppelinux commented 8 months ago

Done here https://github.com/italia/eudi-wallet-it-python/pull/205