ioos / ioos_qc

:ballot_box_with_check: :ocean: IOOS QARTOD and other Quality Control tests implemented in Python
https://ioos.github.io/ioos_qc/
Apache License 2.0
46 stars 27 forks source link

Can't import StreamConfig #99

Open benjwadams opened 1 year ago

benjwadams commented 1 year ago

Attempting to import ioos_qc.config.StreamConfig according to the docs at https://ioos.github.io/ioos_qc/usage.html#streamconfig fails when using 2.1.0:

>>> import ioos_qc
>>> ioos_qc.__version__
'2.1.0'
>>> from ioos_qc.config import StreamConfig
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: cannot import name 'StreamConfig' from 'ioos_qc.config' (/home/badams/miniconda3/envs/ioos-qc-front-end/lib/python3.10/site-packages/ioos_qc/config.py)
>>> from ioos_qc.config import QcConfig

grepping I don't see a class definition for StreamConfig, but importing the old QcConfig appears to work. However, this ends up being confusing since StreamConfig is referenced by the current docs.

kwilcox commented 1 year ago

The docs need to be updated, the only interface you need to load any config object is the Config class: from ioos_qc.config import Config