time-split 0.7.0__tar.gz → 0.7.1__tar.gz

{time_split-0.7.0 → time_split-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: time-split
-Version: 0.7.0
+Version: 0.7.1
 Summary: Time-based k-fold validation splits for heterogeneous data.
 License: MIT
 Keywords: hyper,parameter,optimization,cross,validation,time,temporal,heterogenous,data
@@ -93,6 +93,9 @@ in the terminal. You may use
 [`create_explorer_link()`](https://time-split.readthedocs.io/en/stable/api/time_split.app.html#time_split.app.create_explorer_link)
 to build application URLs with preselected splitting parameters.
 
+Click [here](https://time-split.readthedocs.io/en/stable/api/time_split.app.reexport.html) for documentation of the most
+important types, functions and classes used by the application.
+
 ## Installation
 The package is published through the [Python Package Index (PyPI)]. Source code
 is available on GitHub: https://github.com/rsundqvist/time-split

{time_split-0.7.0 → time_split-0.7.1}/README.md

@@ -55,6 +55,9 @@ in the terminal. You may use
 [`create_explorer_link()`](https://time-split.readthedocs.io/en/stable/api/time_split.app.html#time_split.app.create_explorer_link)
 to build application URLs with preselected splitting parameters.
 
+Click [here](https://time-split.readthedocs.io/en/stable/api/time_split.app.reexport.html) for documentation of the most
+important types, functions and classes used by the application.
+
 ## Installation
 The package is published through the [Python Package Index (PyPI)]. Source code
 is available on GitHub: https://github.com/rsundqvist/time-split

{time_split-0.7.0 → time_split-0.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "time-split"
-version = "0.7.0"
+version = "0.7.1"
 description = "Time-based k-fold validation splits for heterogeneous data."
 authors = [
     { name = "Richard Sundqvist", email = "richard.sundqvist@live.se" },

{time_split-0.7.0 → time_split-0.7.1}/src/time_split/__init__.py

@@ -11,6 +11,6 @@ __all__ = [
     "split",
 ]
 
-__version__ = "0.7.0"
+__version__ = "0.7.1"
 
 _logging.getLogger(__name__).addHandler(_logging.NullHandler())

time_split-0.7.1/src/time_split/app/reexport/__init__.py

@@ -0,0 +1,58 @@
+"""Reexported resources from the ``time_split_app`` namespace.
+
+Running ``python -m time_split app new`` will create a ``Dockerfile`` and a simple ``my_extensions.py`` module.
+
+Environment variables:
+    Subset of variables used to customize Docker-based deployments.
+
+    .. envvar:: DATASET_LOADER
+
+       A :class:`DataLoaderWidget` instance or type, e.g. ``my_extensions:MyDatasetLoader``.
+
+    .. envvar:: SPLIT_SELECT_FN
+
+       A :attr:`SelectSplitParams`-function, e.g. ``my_extensions:my_select_fn``.
+
+    .. envvar:: PLOT_FN
+
+       A :func:`~time_split.plot`-like function, e.g. ``my_extensions:my_plot_fn``.
+
+    .. envvar:: LINK_FN
+
+       A :func:`.create_explorer_link`-like function, e.g. ``my_extensions:my_link_fn``.
+
+    See https://github.com/rsundqvist/time-split-app/blob/master/src/time_split_app/config.py
+    for more variable-based configuration options.
+"""
+
+from time_split_app.datasets import Dataset, DatasetConfig, DuplicateIndexError, load_dataset, load_dataset_configs
+from time_split_app.widgets import DataLoaderWidget, DurationWidget, select_datetime, select_duration
+from time_split_app.widgets import types as _types
+from time_split_app.widgets.types import QueryParams
+
+SelectSplitParams = _types.SelectSplitParams
+"""Type of :envvar:`SPLIT_SELECT_FN`.
+
+A callable ``() -> split_params``; see :func:`time_split.split`
+and :attr:`~time_split.types.DatetimeIndexSplitterKwargs`.
+"""
+PlotFn = _types.PlotFn
+"""Type of :envvar:`PLOT_FN`."""
+LinkFn = _types.LinkFn
+"""Type of :envvar:`LINK_FN`."""
+
+__all__ = [
+    "DataLoaderWidget",
+    "Dataset",
+    "DatasetConfig",
+    "DuplicateIndexError",
+    "DurationWidget",
+    "LinkFn",
+    "PlotFn",
+    "QueryParams",
+    "SelectSplitParams",
+    "load_dataset",
+    "load_dataset_configs",
+    "select_datetime",
+    "select_duration",
+]