diff --git a/cognite/extractorutils/configtools/__init__.py b/cognite/extractorutils/configtools/__init__.py index 6dbcbb0f..37a17c2f 100644 --- a/cognite/extractorutils/configtools/__init__.py +++ b/cognite/extractorutils/configtools/__init__.py @@ -85,6 +85,8 @@ class MyConfig(BaseConfig): However, all of these things will be automatically done for you if you are using the base Extractor class. """ +from cognite.extractorutils.exceptions import InvalidConfigError + from .elements import ( BaseConfig, CogniteConfig, @@ -99,4 +101,4 @@ class MyConfig(BaseConfig): StateStoreConfig, TimeIntervalConfig, ) -from .loaders import ConfigResolver, load_yaml +from .loaders import ConfigResolver, load_yaml, load_yaml_dict diff --git a/docs/source/docs.rst b/docs/source/docs.rst index 7692d015..a2995903 100644 --- a/docs/source/docs.rst +++ b/docs/source/docs.rst @@ -25,6 +25,7 @@ Extractor configurasions are conventionally written in *hyphen-cased YAML*. Thes Config loader ^^^^^^^^^^^^^ .. autofunction:: cognite.extractorutils.configtools.load_yaml +.. autofunction:: cognite.extractorutils.configtools.load_yaml_dict Base classes @@ -67,6 +68,8 @@ The ``configtools`` module contains several prebuilt config classes for many com :undoc-members: .. autoclass:: cognite.extractorutils.configtools.LocalStateStoreConfig :undoc-members: +.. autoclass:: cognite.extractorutils.configtools.TimeIntervalConfig + :undoc-members: Exceptions @@ -75,14 +78,14 @@ Exceptions .. autoexception:: cognite.extractorutils.configtools.InvalidConfigError -``throttle`` - Tools for throttling ------------------------------------ +.. ``throttle`` - Tools for throttling +.. ----------------------------------- -.. automodule:: cognite.extractorutils.throttle - :members: - :undoc-members: - :inherited-members: - :show-inheritance: +.. .. automodule:: cognite.extractorutils.throttle +.. :members: +.. :undoc-members: +.. :inherited-members: +.. :show-inheritance: @@ -115,6 +118,41 @@ Exceptions :inherited-members: :show-inheritance: +.. automodule:: cognite.extractorutils.uploader._base + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + +.. automodule:: cognite.extractorutils.uploader.assets + :members: + :show-inheritance: + +.. automodule:: cognite.extractorutils.uploader.events + :members: + :show-inheritance: + +.. automodule:: cognite.extractorutils.uploader.files + :members: + :show-inheritance: + +.. automodule:: cognite.extractorutils.uploader.raw + :members: + :show-inheritance: + +.. automodule:: cognite.extractorutils.uploader.time_series + :members: + :show-inheritance: + +``uploader_extractor`` - A module containing a more advanced base extractor class +--------------------------------------------------------------------------------- + +.. automodule:: cognite.extractorutils.uploader_extractor + :members: + :undoc-members: + :inherited-members: + :show-inheritance: + ``util`` - Miscellaneous utilities ----------------------------------