Skip to content

Move the datamodels out of the top level package and into their own pylogbook.models sub-package

Philip Elson requested to merge pelson/pylogbook:feature/separate-models-from-api into develop

Move the datamodels out of the top level package and into their own pylogbook.models sub-package - this reflects the fact that they are public API, but not something that you would construct yourself.

This is actually pretty much a zero-change MR too...

The biggest difference is that you now must use pylogbook.NamedActivity.LHC in order to use a pre-defined activity (and pylogbook.NamedServer for servers).

There is no longer a pylogbook.Event/pylogbook.Activity/pylogbook.Attachment - they've all moved to the pylogbook.models module.

The import structure is now much more clear. The following is the order of things, starting from lowest level to highest:

 * stuff that is used by the low-level client
 * the low-level client
 * the high-level models
 * the high-level client

I also beefed up the docs (https://acc-py.web.cern.ch/gitlab/pelson/pylogbook/docs/feature%2Fseparate-models-from-api/).

Edited by Philip Elson

Merge request reports