Migration guide from dlisio v0.2.x -> v.0.3.x

[ErlendHaa]

Migration guide from dlisio v0.2.x -> v.0.3.x

dlisio v0.3.0 introduce breaking changes to dlisio's main entry point dlisio.load, which is moved to the submodule dlis. After updating to v0.3.0 all scripts must be updated accordingly:

import dlisio

with dlisio.load(path) as files:
    pass

->

from dlisio import dlis

with dlis.load(path) as files:
    pass

The are other breaking changes the Python API as well. All are related to the restructuring of the python module between v0.2.6 and v0.3.0.

• DLIS object types such as Frame, Channel, Tool etc is moved from dlisio.plumbing to dlisio.dlis
• Other DLIS utilities previously residing under dlisio.plumbing are moved to dlisio.dlis.utils. The submodule dlisio.plumbing has ceased to exist.
• dlisio.set_encodings and dlisio.get_encodings are moved to dlisio.common.
• dlisio.errors.ErrorHandler is moved to dlisio.common. The submodule dlisio.errors has ceased to exist.

The reason for the restructuring, and the breaking changes, is to make room for dlisio's new Log Interchange Standard 79 (LIS79) reader that is introduces in v0.3.0. Please refer to the readthedocs for documentation on the new LIS reader.