mgnipy package

mgnipy package#

Subpackages#

Submodules#

mgnipy.cli module#

mgnipy.cli.main(argv=None)[source]#

mgnipy.mgnipy module#

class mgnipy.mgnipy.MGnipy(**config)[source]#

Bases: object

list_resources()[source]#
describe_resource(resource, as_dict=False)[source]#

Describe the supported parameters for a given resource by parsing the docstring of the corresponding endpoint module.

Parameters:

  • resource (str ) – The name of the resource to describe.

  • as_dict (bool , optional) – Whether to return the description as a dictionary mapping parameter names to their descriptions (default is False).

Returns:

A dictionary mapping parameter names to their descriptions if as_dict is True, otherwise None.

Return type:

dict of str to str or None

describe_resources(resource=None, as_dict=False)[source]#
Parameters:
Return type:

dict [str , str ] | None

Contents