VFB workshop feature requests

[schlegelp]

Collecting feature requests from the workshop here:

• for convenience, it'd be nice if single search parameters (e.g. types or VFB IDs) would not need to be wrapped in lists but can be provided as just a string
• return pandas.DataFrames by default and make raw data return optional (e.g. via return_json=True)
• docstrings (I appreciate that this might have to wait until the API is more stable)

Maybe @jefferis and others might like to pitch in and add stuff.

[jefferis]

Those were the main ones we discussed. They come up multiple times in different groups.

[dosumis]

for convenience, it'd be nice if single search parameters (e.g. types or VFB IDs) would not need to be wrapped in lists but can be provided as just a string

More flexible to allow list input

return pandas.DataFrames by default and make raw data return optional (e.g. via return_json=True)

Agreed (we need the JSON return on all methods so they can be exposed through the REST API). However, changing the default will break NoteBook examples, so we should tie these to compatible versions

docstrings (I appreciate that this might have to wait until the API is more stable)

These are actually all fixed, e.g. see https://vfb-connect.readthedocs.io/en/stable/API_reference.html , but we had some problem with the last release (reverting to 1.2.5 on pip install). Fixing now.