Guidelines on what to import in __init__.py

[soininen]

Discussed in the developer meeting 2024-04-09.

We import certain functions/classes/etc. in spinedb_api.__init__ so client code can import that stuff more easily, e.g. use from spinedb_api import DatabaseMapping instead of from spinedb_api.db_mapping import DatabaseMapping.

We do not want everything to be available in __init__.py so what should we import there? Some ideas from the developer meeting:

• Core classes/functions:
  • Things that are specifically mentioned in the API reference
  • Selected functionality from spinedb_api.filters