rootlp 0.1.7__py3-none-any.whl

rootlp/modules/readme_string_LP/readme_string.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2026-01-18
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : rootLP
+# Module        : readme_string
+
+"""
+This module returns the readme file text as a string.
+"""
+
+
+
+# %% Libraries
+from pathlib import Path
+
+
+
+# %% Function
+def readme_string(file) :
+    '''
+    This module returns the readme file text as a string.
+    
+    Parameters
+    ----------
+    file : str
+        __file__ attribute of the main script file.
+
+    Returns
+    -------
+    string : str
+        README text.
+
+    Examples
+    --------
+    >>> from rootlp import readme_string
+    ...
+    >>> readme_string(__file__) # returns text of the readme file
+    '''
+
+    file = Path(file)
+    main_folder = file.parents[1] # main_folder / notebooks / file.py
+    readme_file = main_folder / 'README.md'
+    if readme_file.exists() :
+        return readme_file.read_text()
+    raise ValueError(f"{readme_file} read-me file does not exist")
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

rootlp/modules/readme_string_LP/test_readme_string.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2026-01-18
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : rootLP
+# Module        : readme_string
+
+"""
+This file allows to test readme_string
+
+readme_string : This module returns the readme file text as a string.
+"""
+
+
+
+# %% Libraries
+from corelp import print, debug
+import pytest
+from rootlp import readme_string
+debug_folder = debug(__file__)
+
+
+
+# %% Function test
+def test_function() :
+    '''
+    Test readme_string function
+    '''
+    print('Hello world!')
+
+
+
+# %% Instance fixture
+@pytest.fixture()
+def instance() :
+    '''
+    Create a new instance at each test function
+    '''
+    return readme_string()
+
+def test_instance(instance) :
+    '''
+    Test on fixture
+    '''
+    pass
+
+
+# %% Returns test
+@pytest.mark.parametrize("args, kwargs, expected, message", [
+    #([], {}, None, ""),
+    ([], {}, None, ""),
+])
+def test_returns(args, kwargs, expected, message) :
+    '''
+    Test readme_string return values
+    '''
+    assert readme_string(*args, **kwargs) == expected, message
+
+
+
+# %% Error test
+@pytest.mark.parametrize("args, kwargs, error, error_message", [
+    #([], {}, None, ""),
+    ([], {}, None, ""),
+])
+def test_errors(args, kwargs, error, error_message) :
+    '''
+    Test readme_string error values
+    '''
+    with pytest.raises(error, match=error_message) :
+        readme_string(*args, **kwargs)
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

rootlp/modules/user_inputs_LP/test_user_inputs.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2025-11-30
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : rootLP
+# Module        : user_inputs
+
+"""
+This file allows to test user_inputs
+
+user_inputs : Gets last user inputs dictionnary from global variables.
+"""
+
+
+
+# %% Libraries
+from corelp import debug
+import pytest
+from corelp import user_inputs
+debug_folder = debug(__file__)
+
+
+
+# %% Function test
+def test_user_inputs() :
+    '''
+    Test user_inputs function
+    '''
+    user_inputs() #init
+    a = 1
+    inputs = user_inputs()
+    if inputs != {'a': 1} :
+        raise ValueError(f'{inputs} should be dict(a=1)')
+    user_inputs() #init
+    b = 2
+    inputs = user_inputs()
+    if inputs != {'b': 2} :
+        raise ValueError(f'{inputs} should be dict(b=2)')
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

rootlp/modules/user_inputs_LP/user_inputs.py

@@ -0,0 +1,103 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2025-11-30
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : rootLP
+# Module        : user_inputs
+
+"""
+Gets last user inputs dictionnary from global variables.
+"""
+
+
+
+# %% Libraries
+import inspect
+import marimo as mo
+
+
+
+# %% Function
+
+def user_inputs(reset=False) :
+    r"""
+    Return a dictionary of variables defined by the user in the interactive environment.
+
+    Parameters
+    ----------
+    reset : bool or str
+        True to set as first call, String value to define a group of parameters
+
+    Returns
+    -------
+    dict
+        A dictionary containing the user's currently defined variables.
+
+    Examples
+    --------
+    >>> from corelp import user_inputs
+    >>> user_inputs(True)       # First call (initializes and clears import-related variables)
+    None
+    >>> a = 1               # User defines a variable
+    >>> user_inputs()       # Now returns: {'a': 1}
+    {'a': 1}
+    """
+    frame = inspect.currentframe().f_back
+    ns = {**frame.f_globals, **frame.f_locals}
+
+    # ---- Filter user variables (ignore internals starting with "_") ----
+    ns = {key: value for key, value in ns.items() if not key.startswith("_")}
+
+    # Validate status
+    if reset :
+        user_inputs.cache = None
+        if isinstance(reset, str) : # Group reset
+            user_inputs.current_group = reset
+        else :
+            user_inputs.current_group = None
+            user_inputs.groups_values = {}
+            user_inputs.groups_comments = {}
+
+
+    # Case when user_inputs is on top : cache = None
+    if user_inputs.cache is None :
+        user_inputs.cache = ns
+        return
+
+    # Case when user_inputs is at bottom : cache = dict
+    else :
+        updated = { key: value for key, value in ns.items() if key not in user_inputs.cache or user_inputs.cache[key] is not value}
+        values = {key: value for key, value in updated.items() if not key.endswith('_')}
+        comments = {key: value for key, value in updated.items() if key.endswith('_')}
+        
+        # Group values
+        if user_inputs.current_group is not None :
+            user_inputs.groups_values[user_inputs.current_group] = values
+            user_inputs.groups_comments[user_inputs.current_group] = comments
+
+        # End
+        user_inputs.current_group = None
+        user_inputs.cache = None
+        return values
+
+user_inputs.cache = None
+user_inputs.current_group = None
+user_inputs.groups_values = {}
+user_inputs.groups_comments = {}
+user_inputs.export = lambda: (
+    {key: value
+     for group in user_inputs.groups_values.values()
+     for key, value in group.items()},
+    mo.md("---\n\n## **Script user inputs**\n\n" + "".join(
+        f"### {group_name}\n\n"
+        + "".join(f"{ui}\n\n" for ui in group.values())
+        for group_name, group in user_inputs.groups_values.items()
+    ))
+)
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

rootlp/modules.json

@@ -0,0 +1,56 @@
+{
+    "Section": {
+        "date": "2025-08-28",
+        "description": "This class defines decorator instances allowing to create section functions.",
+        "module": "modules/Section_LP/Section",
+        "object": "Section"
+    },
+    "getfunction": {
+        "date": "2026-01-11",
+        "description": "This function is to be used in a script source __init__ file It creates lazy imports of the module imported and defines __getattr__ and __all__ for this source.",
+        "module": "modules/getfunction_LP/getfunction",
+        "object": "getfunction"
+    },
+    "main": {
+        "date": "2025-08-28",
+        "description": "This function can decorate the main function of a script.",
+        "module": "modules/main_LP/main",
+        "object": "main"
+    },
+    "menu": {
+        "date": "2026-01-18",
+        "description": "This module creates a menu on the side of the marimo window.",
+        "module": "modules/menu_LP/menu",
+        "object": "menu"
+    },
+    "mo": {
+        "date": "2026-01-18",
+        "description": "Marimo library shortcut.",
+        "module": "modules/mo_LP/mo",
+        "object": "mo"
+    },
+    "print": {
+        "date": "2025-08-27",
+        "description": "This function overrides python built in print function to add functionnalities.",
+        "module": "modules/print_LP/print",
+        "object": "print"
+    },
+    "project_server": {
+        "date": "2026-01-18",
+        "description": "This module creates and run a custom marimo server for the project.",
+        "module": "modules/project_server_LP/project_server",
+        "object": "project_server"
+    },
+    "readme_string": {
+        "date": "2026-01-18",
+        "description": "This module returns the readme file text as a string.",
+        "module": "modules/readme_string_LP/readme_string",
+        "object": "readme_string"
+    },
+    "user_inputs": {
+        "date": "2025-11-30",
+        "description": "Gets last user inputs dictionnary from global variables.",
+        "module": "modules/user_inputs_LP/user_inputs",
+        "object": "user_inputs"
+    }
+}

rootlp/scripts.json

@@ -0,0 +1 @@
+{}

rootlp-0.1.7.dist-info/METADATA

@@ -0,0 +1,41 @@
+Metadata-Version: 2.3
+Name: rootlp
+Version: 0.1.7
+Summary: A library that gathers root functions for custom script execution.
+Requires-Dist: corelp
+Requires-Dist: joblib
+Requires-Dist: marimo
+Requires-Dist: rich
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# rootLP
+
+```text
+Author        : Lancelot PINCET
+GitHub        : https://github.com/LancelotPincet/rootLP
+HTTPS         : https://github.com/LancelotPincet/rootLP.git
+SSH           : git@github.com:LancelotPincet/rootLP.git
+PyPI          : https://pypi.org/project/rootLP
+Docs          : https://rootLP.readthedocs.io
+```
+
+**A library that gathers root functions for custom script execution.**
+
+rootLP is available on [PyPI](https://pypi.org/project/rootLP) for pip installs.
+For more information, do not hesitate to consult the [Documentation](https://rootLP.readthedocs.io).
+
+---
+
+## MIT License
+
+<details>
+<summary>details</summary>
+
+Intellectual property behind this Library is protected via an [MIT license](LICENSE). This means everyone can *freely* use it in a personnal, academic or commercial manner, if they **keep the copyright name** at the top of the codes.
+
+The library can be redistributed, *with or without modifications*, in open or closed projects. However the **MIT license must be conserved**. For example in a commercial closed project, this means the **copyright and license must be visible somewhere**, like in the documentation or credits.
+
+The license also explains that the **code performances are not warrantied**, and you are responsible for how you are using it. For more information on your rights and obligations please refer to [descriptive websites](https://en.wikipedia.org/wiki/MIT_License), or contact author for approvales.
+
+</details>

rootlp-0.1.7.dist-info/RECORD

@@ -0,0 +1,36 @@
+rootlp/__init__.py,sha256=1-79GsWLVLhDZoWO_E0JM7Fwr1oye_8Og0ulB9x46mw,455
+rootlp/modules/Section_LP/Section.py,sha256=fKfDMOGaX-WpMiA-mKUSfXJRqYlgS_i23hcNnsB8ppY,6116
+rootlp/modules/Section_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rootlp/modules/Section_LP/test_Section.py,sha256=Ew2JfW5vuzugQ2FOc8tRT25s45au653dEfohNcAZPgM,830
+rootlp/modules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rootlp/modules/getfunction_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rootlp/modules/getfunction_LP/getfunction.py,sha256=hB3ZN0tO1QCK85WJeE92_hTvxE8zD6Lj4xVELbKsukY,2504
+rootlp/modules/getfunction_LP/test_getfunction.py,sha256=1qNutF39nZp8OF140t1E6vbUJoq3BgqQ5Al6PznzCnM,1613
+rootlp/modules/main_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rootlp/modules/main_LP/main.py,sha256=mCm-2IT3Y0U74BpRUNM_VodXJbusv-yVQAIvKF32NvM,16737
+rootlp/modules/main_LP/test_main.py,sha256=X0Zslp99Kzf_zGhYzb_qZPnr3oUFI0Q0yQSKy11SZHo,1734
+rootlp/modules/menu_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rootlp/modules/menu_LP/menu.py,sha256=Rg6I8WOF7vSZ2MY3K6oROVKlygbf0_VYEJdPwPpu4bU,1671
+rootlp/modules/menu_LP/test_menu.py,sha256=Vc7JgkFgjKntGKuuKh-eje9WB1ulhaMl5U7xWeIb1js,1463
+rootlp/modules/mo_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rootlp/modules/mo_LP/mo.py,sha256=Ywb1Jl_bWVPOFGj2D9oaEIABcnc7a02doIZ0KorW3Ik,379
+rootlp/modules/mo_LP/test_mo.py,sha256=AT9jWAFFTMiZqp8MgPPjNLuOI_3DpljiMbCtqfU6UuM,1407
+rootlp/modules/print_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rootlp/modules/print_LP/print.py,sha256=IPmXtH8j5lw2ruFSxnT00ccjwja6Z3uZZhUGnFxoA2U,9364
+rootlp/modules/print_LP/test_print.py,sha256=ZllWhhMtmtC3xulw4E0XPhVLtFT_sKjmodADAgw8L3k,2310
+rootlp/modules/project_server_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rootlp/modules/project_server_LP/project_server.py,sha256=ehGWQeQgwGkTrt2SidCiHsCC_OBpvdTH3UJDrEPBI1U,2536
+rootlp/modules/project_server_LP/test_project_server.py,sha256=sFWZAPM2J4vWxAOcGU6mPdWkQZYXVoSmHGSn1CjB5Ws,1570
+rootlp/modules/readme_string_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rootlp/modules/readme_string_LP/readme_string.py,sha256=qZJvfzdyWVfrIzHZfsMSCLOzvFJqRZee7k3ym8iFHx8,1120
+rootlp/modules/readme_string_LP/test_readme_string.py,sha256=iFqIqm0WyGPObyXZdUK47wYWNk1HB65rJd8URFo6lm4,1546
+rootlp/modules/user_inputs_LP/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rootlp/modules/user_inputs_LP/test_user_inputs.py,sha256=2WnIXsT8bSUSACoOAC-CwijEj55TD0bVllZOA39MSNU,940
+rootlp/modules/user_inputs_LP/user_inputs.py,sha256=149Q8zW3iRs-ze2pF-YI6Ne8SUrM9MgQ7LCENDG16WE,3021
+rootlp/modules.json,sha256=26jONcavFN8ackYpzEfVdBR1x4JDSC96qWjuqN9ezw8,2079
+rootlp/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rootlp/scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rootlp/scripts.json,sha256=RBNvo1WzZ4oRRq0W9-hknpT7T8If536DEMBg9hyq_4o,2
+rootlp-0.1.7.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
+rootlp-0.1.7.dist-info/METADATA,sha256=d2aA-wvNEzE1a7sPXchfnLFlN4pFgYVXUJrozNKZ1wg,1751
+rootlp-0.1.7.dist-info/RECORD,,

rootlp-0.1.7.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.26
+Root-Is-Purelib: true
+Tag: py3-none-any