Add a pyam.iiasa.platforms() function

[danielhuppmann]

Please confirm that this PR has done the following:

• Tests Added
• Documentation Added
• Name of contributors Added to AUTHORS.rst
• Description in RELEASE_NOTES.md Added

Description of PR

This PR adds a method pyam.iiasa.list_platforms() as a shorthand for the ixmp4 function down in the config hierarchy, producing an output like:

IIASA platform      Access    Notice

public-test         public    This is a public ixmp4 test instance hosted by the ... 
ecemf               private   
genie               public    This is a development instance for the GENIE knowle... 
ssp-extensions      public    
ecemf-internal      private   

5 total 

I modified this from the corresponding method in ixmp4 showing name, access level and notice (instead of dsn), because this seems more relevant for a Python-API-user.

@meksor, if you agree, I can implement the corresponding change in ixmp4?

Update

Renamed the function to pyam.iiasa.connections() to avoid naming conflict with the ixmp4 method.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.8%. Comparing base (666d49c) to head (5d65095).

Additional details and impacted files

@@          Coverage Diff          @@
##            main    #829   +/-   ##
=====================================
  Coverage   94.8%   94.8%           
=====================================
  Files         64      64           
  Lines       6125    6144   +19     
=====================================
+ Hits        5810    5829   +19     
  Misses       315     315           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[meksor]

Hm it would be useful to see if one is connecting via rest or sqlalchemy, maybe just showing the protocol part of the dsn?
Something like dsn.split('://')[0]

[danielhuppmann]

Hm it would be useful to see if one is connecting via rest or sqlalchemy, maybe just showing the protocol part of the dsn?

My suggestion only refers to the attributes when connecting via the manager - the toml would still have the dsn.

[phackstock]

Good to merge from my side, just two small comments

[meksor]

Ah I see, alright convinced!