datastock 0.0.46__py3-none-any.whl → 0.0.49__py3-none-any.whl

datastock/_class2.py

@@ -629,7 +629,7 @@ class DataStock2(DataStock1):
                         v0['handle'].parent(),
                     )
                 except Exception as err:
-                    error = err
+                    error = "1\n" + str(err)
             elif hasattr(v0['handle'], 'parent'):
                 try:
                     v0['handle'].manager.toolbar.__init__(
@@ -637,9 +637,12 @@ class DataStock2(DataStock1):
                         v0['handle'].parent(),
                     )
                 except Exception as err:
-                    error = True
+                    if "can't initialize an object twice" in str(err):
+                        pass
+                    else:
+                        error = "2\n" + str(err)
             else:
-                error = True
+                error = "3"
 
             if error is not False:
                 import platform
@@ -648,6 +651,7 @@ class DataStock2(DataStock1):
                 lstr0 = [f"\t- {k1}" for k1 in dir(v0['handle'])]
                 lstr1 = [f"\t- {k1}" for k1 in dir(v0['handle'].manager.toolbar)]
                 msg = (
+                    "Problem with connect()\n"
                     f"platform: {platform.platform()}\n"
                     f"python: {sys.version}\n"
                     f"backend: {plt.get_backend()}\n"
@@ -657,7 +661,7 @@ class DataStock2(DataStock1):
                     + "\n".join(lstr1)
                 )
                 if error is not True:
-                    msg += '\n' + str(err)
+                    msg += '\n' + str(error)
                 warnings.warn(msg)
 
             self._dobj['canvas'][k0]['cid'] = {
@@ -1393,4 +1397,4 @@ class DataStock2(DataStock1):
 
 __all__ = [
     sorted([k0 for k0 in locals() if k0.startswith('DataStock')])[-1]
-]
+]

datastock/_class2_interactivity.py

@@ -459,12 +459,18 @@ def _get_ix_for_refx_only_1or2d(
 
 
 def get_fupdate(handle=None, dtype=None, norm=None, bstr=None):
+
+    # Note: set_xdata() and set_ydata() do not accept scalar values
+    #       Deprecation warning since matplotlib 3.7
+    # see https://github.com/matplotlib/matplotlib/pull/22329
+    # see https://github.com/matplotlib/matplotlib/issues/28927
+
     if dtype == 'xdata':
         def func(val, handle=handle):
-            handle.set_xdata(val)
+            handle.set_xdata(np.atleast_1d(val))
     elif dtype == 'ydata':
         def func(val, handle=handle):
-            handle.set_ydata(val)
+            handle.set_ydata(np.atleast_1d(val))
     elif dtype in ['data']:   # Also works for imshow
         def func(val, handle=handle):
             handle.set_data(val)
@@ -588,4 +594,4 @@ def _update_mobile(k0=None, dmobile=None, dref=None, ddata=None):
                     # ddata[dmobile[k0]['data'][ii]]['data'][
                         # dmobile[k0]['func_slice'][ii](iref[ii])
                     # ]
-                # )
+                # )

datastock/_generic_check.py

@@ -362,8 +362,6 @@ def _check_dict_valid_keys(
                     var[k0] = None
                     continue
 
-            vv = var.get(k0)
-
             # routine to call
             if any([ss in v0.keys() for ss in lkarray]):
                 var[k0] = _check_flat1darray(
@@ -555,47 +553,125 @@ def _obj_key(d0=None, short=None, key=None, ndigits=None):
 #                   Utilities for plotting
 # #############################################################################
 
-# DEPRECATED
-# def _check_inplace(coll=None, keys=None):
-    # """ Check key to data and inplace """
 
-    # # -----------------------------
-    # # keys of data to be extracted
-    # # ----------------------------
+def _check_all_broadcastable(
+    return_full_arrays=None,
+    **kwdargs,
+):
+
+    # -------------------
+    # return_full_arrays
+    # -------------------
+
+    return_full_arrays = _check_var(
+        return_full_arrays, 'return_full_arrays',
+        types=bool,
+        default=False,
+    )
+
+    # -------------------
+    # Preliminary check
+    # -------------------
+
+    dout = {}
+    dfail = {}
+    for k0, v0 in kwdargs.items():
+        try:
+            dout[k0] = np.atleast_1d(v0)
+        except Exception:
+            dfail[k0] = f"Not convertible to np.ndarray! - {v0}"
+
+    # Raise Exception
+    if len(dfail) > 0:
+        lstr = [f"\t- {k0}: {v0}" for k0, v0 in dfail.items()]
+        msg = (
+            "The following kwdargs are non-conform:\n"
+            + "\n".join(lstr)
+        )
+        raise Exception(msg)
 
-    # if isinstance(keys, str):
-        # keys = [keys]
-    # keys = _check_var_iter(
-        # keys, 'keys',
-        # default=None,
-        # types=list,
-        # types_iter=str,
-        # allowed=list(coll.ddata.keys()),
-    # )
+    # -------------------
+    # check ndim
+    # -------------------
 
-    # # ----------------------
-    # # extract sub-collection
-    # # ----------------------
+    dndim = {k0: v0.ndim for k0, v0 in dout.items() if v0.shape != (1,)}
+    lndim = list(set(dndim.values()))
 
-    # lk0 = list(keys)
-    # for key in keys:
+    if len(lndim) == 0:
+        # all scalar
+        if return_full_arrays:
+            return dout, (1,)
+        else:
+            return {k0: v0[0] for k0, v0 in dout.items()}, None
 
-        # # Include all data matching any single ref
-        # for rr in coll._ddata[key]['ref']:
-            # for k0, v0 in coll._ddata.items():
-                # if v0['ref'] == (rr,):
-                    # if k0 not in lk0:
-                        # lk0.append(k0)
+    elif len(lndim) == 1:
+        ndim = lndim[0]
 
-        # # include all data matching all refs
-        # for k0, v0 in coll._ddata.items():
-            # if v0['ref'] == coll._ddata[key]['ref']:
-                # if k0 not in lk0:
-                    # lk0.append(k0)
+    else:
+        lstr = [f"\t- {k0}: {v0}" for k0, v0 in dndim.items()]
+        msg = (
+            "Some keyword args have non-compatible dimensions:\n"
+            + "\n".join(lstr)
+        )
+        raise Exception(msg)
 
-    # coll2 = coll.extract(lk0)
+    # -------------------
+    # check shapes
+    # -------------------
 
-    # return keys, coll2
+    dfail = {}
+    shapef = np.ones((ndim,), dtype=int)
+    for k0, v0 in dout.items():
+
+        if v0.shape == (1,):
+            continue
+
+        for ii in range(ndim):
+            if v0.shape[ii] == 1:
+                pass
+            elif shapef[ii] == 1:
+                shapef[ii] = v0.shape[ii]
+            elif v0.shape[ii] == shapef[ii]:
+                pass
+            else:
+                dfail[k0] = f"Non-compatible shape = {v0.shape} (ii = {ii})"
+                continue
+
+    shapef = tuple(shapef)
+
+    # raise Exception if needed
+    if len(dfail) > 0:
+        lstr = [f"\t- {k0}: {v0}" for k0, v0 in dfail.items()]
+        msg = (
+            "The following keywords args have non-compatible shape:\n"
+            + "\n".join(lstr)
+            + f"\nReference shape: {shapef}\n"
+        )
+        raise Exception(msg)
+
+    # -------------------
+    # reshape output
+    # -------------------
+
+    if return_full_arrays is True:
+        for k0, v0 in dout.items():
+            if v0.shape == (1,):
+                dout[k0] = np.full(shapef, v0[0])
+            elif v0.shape != shapef:
+                dout[k0] = np.broadcast_to(v0, shapef)
+
+    else:
+        for k0, v0 in dout.items():
+            if v0.shape == (1,):
+                dout[k0] = v0[0]
+
+    return dout, shapef
+
+
+# #############################################################################
+# #############################################################################
+#                   Utilities for plotting
+# #############################################################################
 
 
 def _check_dax(dax=None, main=None):
@@ -724,7 +800,7 @@ def _check_lim(lim):
     if len(dfail) > 0:
         lstr = [f"\t- lim[{ii}]: {vv}" for ii, vv in dfail.items()]
         msg = (
-            "The following non-conformities in lim have been identified:\n"*
+            "The following non-conformities in lim have been identified:\n"
             + "\n".join(lstr)
         )
         raise Exception(msg)
@@ -780,7 +856,6 @@ def _apply_lim(lim=None, data=None, logic=None):
     return ind
 
 
-
 def _apply_dlim(dlim=None, logic_intervals=None, logic=None, ddata=None):
 
     # ------------
@@ -840,6 +915,7 @@ def _apply_dlim(dlim=None, logic_intervals=None, logic=None, ddata=None):
             lstr = [f"\t- {k0}: {v0}" for k0, v0 in dfail.items()]
             msg = (
                 "The following keys have non-compatible shapes:\n"
+                + "\n".join(lstr)
             )
             raise Exception(msg)
 
@@ -901,11 +977,6 @@ def _apply_dlim(dlim=None, logic_intervals=None, logic=None, ddata=None):
 
 def _check_cmap_vminvmax(data=None, cmap=None, vmin=None, vmax=None):
     # cmap
-    c0 = (
-        cmap is None
-        or vmin is None
-        or vmax is None
-    )
     if cmap is None or vmin is None or vmax is None:
         nanmax = np.nanmax(data)
         nanmin = np.nanmin(data)
@@ -929,4 +1000,4 @@ def _check_cmap_vminvmax(data=None, cmap=None, vmin=None, vmax=None):
         else:
             vmax = nanmax
 
-    return cmap, vmin, vmax
+    return cmap, vmin, vmax

datastock/tests/test_01_DataStock.py

@@ -14,6 +14,7 @@ import numpy as np
 import matplotlib.pyplot as plt
 
 # datastock-specific
+from .._generic_check import _check_all_broadcastable
 from .._class import DataStock
 from .._saveload import load
 
@@ -228,6 +229,46 @@ class Test01_Instanciate():
     def test03_add_obj(self):
         _add_obj(st=self.st, nc=self.nc)
 
+    # ------------------------
+    #   Tools
+    # ------------------------
+
+    def test04_check_all_broadcastable(self):
+        # all scalar
+        dout, shape = _check_all_broadcastable(a=1, b=2)
+
+        # scalar + arrays
+        dout, shape = _check_all_broadcastable(a=1, b=(1, 2, 3))
+
+        # all arrays
+        dout, shape = _check_all_broadcastable(
+            a=(1, 2, 3),
+            b=(1, 2, 3),
+        )
+
+        # all arrays - 2d
+        dout, shape = _check_all_broadcastable(
+            a=np.r_[1, 2, 3][:, None],
+            b=np.r_[10, 20][None, :],
+        )
+
+        # check flag
+        err = False
+        try:
+            dout, shape = _check_all_broadcastable(a=(1, 2), b=(1, 2, 3))
+        except Exception:
+            err = True
+        assert err is True
+
+        # all arrays - mix
+        dout, shape = _check_all_broadcastable(
+            a=np.r_[1, 2, 3][:, None],
+            b=np.r_[10, 20][None, :],
+            c=3,
+            return_full_arrays=True,
+        )
+        assert all([v0.shape == (3, 2) for v0 in dout.values()])
+
 
 #######################################################
 #
@@ -639,4 +680,4 @@ class Test02_Manipulate():
         msg = st2.__eq__(self.st, returnas=str)
         if msg is not True:
             raise Exception(msg)
-        os.remove(pfe)
+        os.remove(pfe)

datastock/version.py

@@ -1,2 +1,2 @@
 # Do not edit, pipeline versioning governed by git tags!
-__version__ = '0.0.46'
+__version__ = '0.0.49'

{datastock-0.0.46.dist-info → datastock-0.0.49.dist-info}/METADATA

@@ -1,20 +1,43 @@
 Metadata-Version: 2.1
 Name: datastock
-Version: 0.0.46
-Summary: A python library for generic class and data handling
+Version: 0.0.49
+Summary: Generic handler for multiple heterogenous numpy arrays and subclasses
 Home-page: https://github.com/ToFuProject/datastock
 Author: Didier VEZINET
-Author-email: didier.vezinet@gmail.com
-License: MIT
-Keywords: data analysis class container generic interactive plot
-Classifier: Development Status :: 4 - Beta
+Author-email: Didier VEZINET <didier.vezinet@gmail.com>
+Maintainer-email: Didier VEZINET <didier.vezinet@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2022 ToFuProject
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Keywords: data,analysis,interactive,heterogeneous arrays,numpy,Collection
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Science/Research
-Classifier: Topic :: Scientific/Engineering :: Physics
-Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
-Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -29,6 +52,10 @@ Requires-Dist: pytest; extra == "dev"
 Requires-Dist: sphinx; extra == "dev"
 Requires-Dist: sphinx-gallery; extra == "dev"
 Requires-Dist: sphinx-bootstrap-theme; extra == "dev"
+Provides-Extra: formatting
+Requires-Dist: ruff; extra == "formatting"
+Provides-Extra: linting
+Requires-Dist: ruff; extra == "linting"
 
 [![Conda]( https://anaconda.org/conda-forge/datastock/badges/version.svg)](https://anaconda.org/conda-forge/datastock)
 [![](https://anaconda.org/conda-forge/datastock/badges/downloads.svg)](https://anaconda.org/conda-forge/datastock)

{datastock-0.0.46.dist-info → datastock-0.0.49.dist-info}/RECORD

@@ -12,13 +12,13 @@ datastock/_class1_domain.py,sha256=_xUCnwWJX5wPPYrpiGGrRwrPLmiO5BMm3nmYvn_YEOg,6
 datastock/_class1_interpolate.py,sha256=3VKGMDsiWFQUguMHxMaTQTyMhcN8Ikg1PmaH6TjIeLg,38348
 datastock/_class1_show.py,sha256=hqd-FeJ1NqiOzbrHzGMrwIo8_lLsjC199Zmw68NqkDQ,11745
 datastock/_class1_uniformize.py,sha256=dEJime_0SqmW8hX8ooZpHsPI_d8CIE9U9Yz9GhqsEUY,28433
-datastock/_class2.py,sha256=FG-ZGPVdZEdkRc_3Z9LRzYdRm9Xat7HI06E3-hI5rCk,45422
-datastock/_class2_interactivity.py,sha256=b7ORi0wR-gcFIua10PhbKTEB12vJN1F4skuIJX0gnbw,16918
+datastock/_class2.py,sha256=Mkqwhkl-YDAT0Wx5bHkUHwMW2L6feACkxmifvvzUnYk,45626
+datastock/_class2_interactivity.py,sha256=glAqqkIyH8JBVj0AsgJPNlaltcTIXB0iCqNBq3gKSb8,17198
 datastock/_class3.py,sha256=CH1oD_lTfVlcDp29L_iwzSfP78vX6_edDmZG9aSb1Ks,10848
 datastock/_direct_calls.py,sha256=EHFwI2mGMDqGz8_Bv2BseMBX4J8dSdE_RcNX3pt0ZYY,1801
 datastock/_export_dataframe.py,sha256=fy-uJR3EhDlHvd9ls1EQna_C8fyha1jCJLu1DTKTkdo,1576
 datastock/_find_plateau.py,sha256=sqnAuy0361DXkqBb_Lo1MmIGjn35tnKFvcv6MW6hifs,2685
-datastock/_generic_check.py,sha256=x41ITg3NxOiMK4IyIQX9wYrrqwPy88991rlvCpkFy8w,24812
+datastock/_generic_check.py,sha256=4NmG7iPa02bxOC5K-6qw63UahQ2FNDbeKu_AGBpNMtc,26717
 datastock/_generic_utils.py,sha256=_iV51SiujEmQfAlvyIEW4BvzIXdhPCD-vumV5DmUL44,23421
 datastock/_generic_utils_plot.py,sha256=xrWzeZFtdTAs-RO2DfpCRveJPqw_p4lRFtQuuAn1pD8,3709
 datastock/_plot_BvsA_as_distribution.py,sha256=fpRhlbv3Bk96buANC46Brc9hdLxkOAsoKpE5A9pohG0,15389
@@ -32,12 +32,17 @@ datastock/_plot_correlations.py,sha256=ITOypu_AEoKl0ihxocV-JVTXIHqut6p9TfG-xZmQy
 datastock/_plot_old_backup.py,sha256=XixTi2CiihKjtQP0TRycH0b25caWN1m35DgpsDeiWZE,21729
 datastock/_plot_text.py,sha256=wQPqjfpLyIioS2JeOt3E9C9HgYUJ49YEoOgRuKYvAR8,3143
 datastock/_saveload.py,sha256=1vAMp27KfqXbo5b_Pi8hJux0stsHq6dO5vy8k1d4_iA,14141
-datastock/version.py,sha256=TTZXyi6fkfPDWOJIxiEa00X66SrcWUHC11j32Bjcyh0,80
+datastock/version.py,sha256=3LGOrbR0FKVCMYF5gFB0Z3jb_YfYLLDyuMY0M-oeJrU,80
 datastock/tests/__init__.py,sha256=teOo2xP0IO7PQMuMDmum61XVHe2TuxW3BiHiL73X8jQ,35
-datastock/tests/test_01_DataStock.py,sha256=Ngz0nbb7Qj3Sr0c4TV2OlK_v4R6aMBrQYXr8BWaYAnw,18048
+datastock/tests/test_01_DataStock.py,sha256=aUseXH2zYnFtNDJSCuEROgPxfKKNeLCkCQSR--_Fheg,19176
 datastock/tests/output/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-datastock-0.0.46.dist-info/LICENSE,sha256=V1uXqi3vxR0QhB4QdFyjkynl6jpN4wZmlB5EMYJk0NM,1068
-datastock-0.0.46.dist-info/METADATA,sha256=rs7ozSmlV2xJ4_yOJIwDrDj3brqxOHxqZRlG7W2hLqA,8660
-datastock-0.0.46.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-datastock-0.0.46.dist-info/top_level.txt,sha256=BzJsLLK_zZw13WQCoMhC74qWVKalnVCjBxdPXvJn7HQ,25
-datastock-0.0.46.dist-info/RECORD,,
+scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scripts/_bash_version.py,sha256=B-NJPgjuqGiXVVUEBJDHP4uDc5yBDFvBX2mmvL2T4E0,1837
+scripts/_dparser.py,sha256=TvJ4ZWbOX0sN8Xqa-IRhcqtyOIIewRTkeb-OE0vXWbs,2755
+scripts/main.py,sha256=JrRRQK3BCnepBa0RMsG3OtpMCoVRo_RcElMScPcbvF4,3530
+datastock-0.0.49.dist-info/LICENSE,sha256=V1uXqi3vxR0QhB4QdFyjkynl6jpN4wZmlB5EMYJk0NM,1068
+datastock-0.0.49.dist-info/METADATA,sha256=KVm2w4WDF--bfwCyc8TaKyn_5vvc45wReU07WuhnkVY,10197
+datastock-0.0.49.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+datastock-0.0.49.dist-info/entry_points.txt,sha256=GqmxVVp9G2ulEDaS9gLpwSVOBLF_FEBlj8k5Z6TJKsc,42
+datastock-0.0.49.dist-info/top_level.txt,sha256=4mahLJQfvNnKq213ODWrMXeNzyoyjzRRke_OAw07iA8,33
+datastock-0.0.49.dist-info/RECORD,,

{datastock-0.0.46.dist-info → datastock-0.0.49.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.3.0)
+Generator: bdist_wheel (0.45.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

datastock-0.0.49.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[datastock]
+datastock = scripts.main:main

{datastock-0.0.46.dist-info → datastock-0.0.49.dist-info}/top_level.txt

@@ -1,2 +1,3 @@
 _updateversion
 datastock
+scripts

scripts/_bash_version.py

@@ -0,0 +1,77 @@
+#!/usr/bin/env python
+
+# Built-in
+import os
+
+
+###################################################
+###################################################
+#       DEFAULTS
+###################################################
+
+
+_PATH_HERE = os.path.dirname(__file__)
+
+
+###################################################
+###################################################
+#       function
+###################################################
+
+
+def main(
+    verb=None,
+    envvar=None,
+    path=None,
+    warn=None,
+    force=None,
+    ddef=None,
+):
+    """ Print version """
+
+    # --------------
+    # Check inputs
+    # --------------
+
+    kwd = locals()
+    for k0 in set(ddef.keys()).intersection(kwd.keys()):
+        if kwd[k0] is None:
+            kwd[k0] = ddef[k0]
+    verb, path = kwd['verb'], kwd['path']
+
+    # verb, warn, force
+    dbool = {'verb': verb}
+    for k0, v0 in dbool.items():
+        if v0 is None:
+            dbool[k0] = ddef[k0]
+        if not isinstance(dbool[k0], bool):
+            msg = (
+                f"Arg '{k0}' must be a bool\n"
+                f"\t- provided: {dbool[k0]}\n"
+            )
+            raise Exception(msg)
+
+    # --------------
+    # Fetch version from git tags, and write to version.py
+    # Also, when git is not available (PyPi package), use stored version.py
+
+    pfe = os.path.join(path, 'version.py')
+    if not os.path.isfile(pfe):
+        msg = (
+            "It seems your current install has no version.py:\n"
+            f"\t- looked for: {pfe}"
+        )
+        raise Exception(msg)
+
+    # --------------
+    # Read file
+
+    with open(pfe, 'r') as fh:
+        version = fh.read().strip().split("=")[-1].replace("'", '')
+    version = version.lower().replace('v', '').replace(' ', '')
+
+    # --------------
+    # Outputs
+
+    if dbool['verb'] is True:
+        print(version)

scripts/_dparser.py

@@ -0,0 +1,109 @@
+import sys
+import os
+import getpass
+import argparse
+
+
+# test if in a git repo
+_HERE = os.path.abspath(os.path.dirname(__file__))
+_REPOPATH = os.path.dirname(_HERE)
+_REPO_NAME = 'datastock'
+
+
+# #############################################################################
+#       utility functions
+# #############################################################################
+
+
+def _str2bool(v):
+    if isinstance(v, bool):
+        return v
+    elif v.lower() in ['yes', 'true', 'y', 't', '1']:
+        return True
+    elif v.lower() in ['no', 'false', 'n', 'f', '0']:
+        return False
+    else:
+        raise argparse.ArgumentTypeError('Boolean value expected!')
+
+
+def _str2boolstr(v):
+    if isinstance(v, bool):
+        return v
+    elif isinstance(v, str):
+        if v.lower() in ['yes', 'true', 'y', 't', '1']:
+            return True
+        elif v.lower() in ['no', 'false', 'n', 'f', '0']:
+            return False
+        elif v.lower() == 'none':
+            return None
+        else:
+            return v
+    else:
+        raise argparse.ArgumentTypeError('Boolean, None or str expected!')
+
+
+def _str2tlim(v):
+    c0 = (v.isdigit()
+          or ('.' in v
+              and len(v.split('.')) == 2
+              and all([vv.isdigit() for vv in v.split('.')])))
+    if c0 is True:
+        v = float(v)
+    elif v.lower() == 'none':
+        v = None
+    return v
+
+
+# #############################################################################
+#       Parser for version
+# #############################################################################
+
+
+def parser_version():
+    msg = f""" Get {_REPO_NAME} version from bash
+
+    If run from a git repo containing {_REPO_NAME}, just returns git describe
+    Otherwise reads the version stored in {_REPO_NAME}/version.py
+
+    """
+    ddef = {
+        'path': os.path.join(_REPOPATH, _REPO_NAME),
+        'envvar': False,
+        'verb': True,
+        'warn': True,
+        'force': False,
+        'name': f'{_REPO_NAME.upper()}_VERSION',
+    }
+
+    # Instanciate parser
+    parser = argparse.ArgumentParser(description=msg)
+
+    # optional path
+    parser.add_argument(
+        '-p', '--path',
+        type=str,
+        help='source directory where version.py is found',
+        required=False,
+        default=ddef['path'],
+    )
+
+    # verb
+    parser.add_argument(
+        '-v', '--verb',
+        type=_str2bool,
+        help='flag indicating whether to print the version',
+        required=False,
+        default=ddef['verb'],
+    )
+
+    return ddef, parser
+
+
+# #############################################################################
+#       Parser dict
+# #############################################################################
+
+
+_DPARSER = {
+    'version': parser_version,
+}

scripts/main.py

@@ -0,0 +1,147 @@
+#!/usr/bin/env python
+
+# Built-in
+import sys
+import os
+import argparse
+
+
+# import parser dicti
+from . import _dparser
+from . import _bash_version
+
+
+###################################################
+###################################################
+#       default values
+###################################################
+
+
+_PATH_HERE = os.path.abspath(os.path.dirname(__file__))
+
+
+_LOPTIONS = ['--version']
+_LOPSTRIP = [ss.strip('--') for ss in _LOPTIONS]
+
+
+###################################################
+###################################################
+#       function
+###################################################
+
+
+def datastock_bash(option=None, ddef=None, **kwdargs):
+    """ Print tofu version and / or store in environment variable """
+
+    # --------------
+    # Check inputs
+    # --------------
+
+    if option not in _LOPSTRIP:
+        msg = (
+            "Provided option is not acceptable:\n"
+            f"\t- available: {_LOPSTRIP}\n"
+            f"\t- provided:  {option}"
+        )
+        raise Exception(msg)
+
+    # --------------
+    # call corresponding bash command
+    # --------------
+
+    if option == 'version':
+        _bash_version.main(
+            ddef=ddef,
+            **kwdargs,
+        )
+
+
+###################################################
+###################################################
+#          main
+###################################################
+
+
+def main():
+    # Parse input arguments
+    msg = """ Get tofu version from bash optionally set an enviroment variable
+
+    If run from a git repo containing tofu, simply returns git describe
+    Otherwise reads the tofu version stored in tofu/version.py
+
+    """
+
+    # ------------------
+    # Instanciate parser
+    # ------------------
+
+    parser = argparse.ArgumentParser(description=msg)
+
+    # ---------------------
+    # which script to call
+    # ---------------------
+
+    parser.add_argument(
+        'option',
+        nargs='?',
+        type=str,
+        default='None',
+    )
+
+    #
+    parser.add_argument(
+        '-v', '--version',
+        help='get tofu current version',
+        required=False,
+        action='store_true',
+    )
+
+    # Others
+    # parser.add_argument('kwd', nargs='?', type=str, default='None')
+
+    # -------------------
+    # check options
+    # -------------------
+
+    if sys.argv[1] not in _LOPTIONS:
+        msg = (
+            "Provided option is not acceptable:\n"
+            f"\t- available: {_LOPTIONS}\n"
+            f"\t- provided:  {sys.argv[1]}\n"
+        )
+        raise Exception(msg)
+
+    if len(sys.argv) > 2:
+        if any([ss in sys.argv[2:] for ss in _LOPTIONS]):
+            lopt = [ss for ss in sys.argv[1:] if ss in _LOPTIONS]
+            msg = (
+                "Only one option can be provided!\n"
+                f"\t- provided: {lopt}"
+            )
+            raise Exception(msg)
+
+    # ----------------------
+    # def values and parser
+    # ----------------------
+
+    option = sys.argv[1].strip('--')
+    ddef, parser = _dparser._DPARSER[option]()
+    if len(sys.argv) > 2:
+        kwdargs = dict(parser.parse_args(sys.argv[2:])._get_kwargs())
+    else:
+        kwdargs = {}
+
+    # ----------------------
+    # Call function
+    # ----------------------
+
+    datastock_bash(option=option, ddef=ddef, **kwdargs)
+
+
+###################################################
+###################################################
+#                   __main__
+###################################################
+
+if __name__ == '__main__':
+    main()