mayutils 1.0.89__tar.gz → 1.2.0__tar.gz

mayutils-1.2.0/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.3
+Name: mayutils
+Version: 1.2.0
+Summary: Utilities for Python from Mayuran Visakan
+Author: Mayuran Visakan
+Author-email: Mayuran Visakan <mayuran.k.v@gmail.com>
+License: MIT License
+         
+         Copyright (c) 2025 Mayuran Visakan
+         
+         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.
+Requires-Dist: asyncer>=0.0.8
+Requires-Dist: chromedriver-autoinstaller>=0.6.4
+Requires-Dist: dataframe-image>=0.2.7
+Requires-Dist: gitpython>=3.1.45
+Requires-Dist: google-api-python-client>=2.179.0
+Requires-Dist: google-auth>=2.40.3
+Requires-Dist: google-auth-httplib2>=0.2.0
+Requires-Dist: google-auth-oauthlib>=1.2.2
+Requires-Dist: google-cloud-storage>=3.3.0
+Requires-Dist: great-tables>=0.18.0
+Requires-Dist: html2image>=2.0.7
+Requires-Dist: ipykernel>=6.30.1
+Requires-Dist: itables>=2.4.5
+Requires-Dist: jupyter>=1.1.1
+Requires-Dist: kaleido>=1.0.0
+Requires-Dist: keyring>=25.6.0
+Requires-Dist: matplotlib>=3.10.5
+Requires-Dist: modin[all]>=0.35.0
+Requires-Dist: nbconvert>=7.16.6
+Requires-Dist: numba>=0.62.0rc1
+Requires-Dist: numpy>=2.3.2
+Requires-Dist: numpy-financial>=1.0.0
+Requires-Dist: pandas>=2.3.2
+Requires-Dist: pathlib>=1.0.1
+Requires-Dist: pendulum[test]>=3.1.0
+Requires-Dist: pillow>=11.3.0
+Requires-Dist: playwright>=1.55.0
+Requires-Dist: plotly>=6.3.0
+Requires-Dist: polars>=1.32.3
+Requires-Dist: pre-commit>=4.3.0
+Requires-Dist: pyarrow>=21.0.0
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: pydantic-settings>=2.10.1
+Requires-Dist: pymupdf>=1.26.4
+Requires-Dist: python-dotenv>=1.1.1
+Requires-Dist: python-pptx>=1.0.2
+Requires-Dist: requests>=2.32.5
+Requires-Dist: rich>=14.1.0
+Requires-Dist: scikit-learn>=1.7.1
+Requires-Dist: scipy>=1.16.1
+Requires-Dist: selenium>=4.35.0
+Requires-Dist: snowflake-connector-python[secure-local-storage]>=3.17.2
+Requires-Dist: snowflake-sqlalchemy>=1.7.6
+Requires-Dist: sqlalchemy>=2.0.43
+Requires-Dist: streamlit>=1.49.0
+Requires-Dist: typer>=0.16.1
+Requires-Dist: unicodeit>=0.7.5
+Requires-Dist: ruff>=0.9.6 ; extra == 'dev'
+Requires-Dist: mypy>=1.15.0 ; extra == 'dev'
+Requires-Dist: pytest>=8.3.4 ; extra == 'dev'
+Requires-Dist: hatch>=1.14.0 ; extra == 'dev'
+Requires-Python: >=3.11, <4.0
+Provides-Extra: dev
+Description-Content-Type: text/markdown
+
+# Mayutils
+
+Utilities for Python

mayutils-1.2.0/pyproject.toml

@@ -0,0 +1,78 @@
+[project]
+name = "mayutils"
+version = "1.2.0"
+description = "Utilities for Python from Mayuran Visakan"
+authors = [
+    { name = "Mayuran Visakan", email = "mayuran.k.v@gmail.com" }
+]
+license = { file = "LICENSE" }
+readme = "README.md"
+requires-python = ">=3.11,<4.0"
+dependencies = [
+    "asyncer>=0.0.8",
+    "chromedriver-autoinstaller>=0.6.4",
+    "dataframe-image>=0.2.7",
+    "gitpython>=3.1.45",
+    "google-api-python-client>=2.179.0",
+    "google-auth>=2.40.3",
+    "google-auth-httplib2>=0.2.0",
+    "google-auth-oauthlib>=1.2.2",
+    "google-cloud-storage>=3.3.0",
+    "great-tables>=0.18.0",
+    "html2image>=2.0.7",
+    "ipykernel>=6.30.1",
+    "itables>=2.4.5",
+    "jupyter>=1.1.1",
+    "kaleido>=1.0.0",
+    "keyring>=25.6.0",
+    "matplotlib>=3.10.5",
+    "modin[all]>=0.35.0",
+    "nbconvert>=7.16.6",
+    "numba>=0.62.0rc1",
+    "numpy>=2.3.2",
+    "numpy-financial>=1.0.0",
+    "pandas>=2.3.2",
+    "pathlib>=1.0.1",
+    "pendulum[test]>=3.1.0",
+    "pillow>=11.3.0",
+    "playwright>=1.55.0",
+    "plotly>=6.3.0",
+    "polars>=1.32.3",
+    "pre-commit>=4.3.0",
+    "pyarrow>=21.0.0",
+    "pydantic>=2.11.7",
+    "pydantic-settings>=2.10.1",
+    "pymupdf>=1.26.4",
+    "python-dotenv>=1.1.1",
+    "python-pptx>=1.0.2",
+    "requests>=2.32.5",
+    "rich>=14.1.0",
+    "scikit-learn>=1.7.1",
+    "scipy>=1.16.1",
+    "selenium>=4.35.0",
+    "snowflake-connector-python[secure-local-storage]>=3.17.2",
+    "snowflake-sqlalchemy>=1.7.6",
+    "sqlalchemy>=2.0.43",
+    "streamlit>=1.49.0",
+    "typer>=0.16.1",
+    "unicodeit>=0.7.5",
+]
+
+[project.optional-dependencies]
+dev = [
+  "ruff>=0.9.6",
+  "mypy>=1.15.0",
+  "pytest>=8.3.4",
+  "hatch>=1.14.0"
+]
+
+[project.scripts]
+clear_cache = "mayutils.scripts.clear_cache:app"
+generate_encryption_key = "mayutils.environment.oauth:generate_fernet_key"
+
+[tool.uv]
+prerelease = "if-necessary-or-explicit"
+
+[build-system]
+requires = ["uv_build>=0.8.14,<0.9.0"]
+build-backend = "uv_build"

mayutils-1.2.0/src/mayutils/__init__.py

@@ -0,0 +1,37 @@
+import sys
+import warnings
+from importlib import metadata
+from pathlib import Path
+
+__version__ = metadata.version(distribution_name="mayutils")
+
+
+def setup(
+    is_script: bool = False,
+) -> None:
+    from mayutils.environment.logging import Logger
+
+    Logger.configure()
+
+    try:
+        from mayutils.objects.dataframes import setup_dataframes
+        from mayutils.visualisation.notebook import setup_notebooks
+
+        setup_notebooks()
+        setup_dataframes()
+
+    except ImportError as err:
+        Logger.spawn().warning(f"Error occurred during setup imports: {err}")
+
+    # TODO: Remove when dependency is upgraded
+    warnings.filterwarnings(
+        action="ignore",
+        message="You have an incompatible version of 'pyarrow' installed.*",
+        category=UserWarning,
+        module="snowflake.connector.options",
+    )
+
+
+print(Path(sys.argv[0]).parent)
+
+setup()

mayutils-1.2.0/src/mayutils/core/constants.py

@@ -0,0 +1,3 @@
+from rich.console import Console
+
+CONSOLE = Console()  # TODO: Rich width for slides should be 72

{mayutils-1.0.89 → mayutils-1.2.0}/src/mayutils/data/__init__.py

@@ -1,9 +1,6 @@
 from pathlib import Path
 
-
-from mayutils.environment.filesystem import (
-    get_module_root,
-)
+from mayutils.environment.filesystem import get_module_root
 
 MODULE_ROOT = get_module_root()
 CACHE_FOLDER = Path(__file__).parent / "cache"

{mayutils-1.0.89 → mayutils-1.2.0}/src/mayutils/environment/benchmarking.py

@@ -16,6 +16,7 @@ def timing(
 ):
     if func is None:
         raise ValueError("No function provided")
+
     @wraps(wrapped=func)
     def wrapper(
         *args,

{mayutils-1.0.89 → mayutils-1.2.0}/src/mayutils/environment/databases.py

@@ -19,7 +19,6 @@ class EngineWrapper(object):
         cls,
         *args,
         **kwargs,
-
     ) -> Self:
         return cls(
             create_engine(

{mayutils-1.0.89 → mayutils-1.2.0}/src/mayutils/export/slides.py

@@ -7,11 +7,10 @@ from shlex import quote as escape
 from rich.progress import Progress, SpinnerColumn, TextColumn, TimeElapsedColumn
 
 from mayutils.visualisation.notebook import (
-    is_interactive,
+    not_nbconvert,
     write_markdown,
 )
 from mayutils.export import OUTPUT_FOLDER
-from mayutils.core.constants import DISPLAY_TYPE_ENV_VAR
 
 WARNING = "Not an ipython notebook"
 
@@ -30,7 +29,7 @@ SLIDES_FOLDER = OUTPUT_FOLDER / "Slides"
 
 
 def is_slides() -> bool:
-    return os.getenv(key=DISPLAY_TYPE_ENV_VAR, default=None) == "slides"
+    return os.getenv(key="_NBCONVERT_OUTPUT_FORMAT", default=None) == "slides"
 
 
 def subtitle_text(
@@ -58,7 +57,7 @@ def export_slides(
     serve: bool = False,
     light: bool = False,
 ) -> Path | None:
-    if not is_interactive():
+    if not not_nbconvert():
         return None
 
     today = date.today().strftime(
@@ -87,7 +86,7 @@ def export_slides(
             total=None,
         )
         call(
-            args=f"{DISPLAY_TYPE_ENV_VAR}=slides jupyter nbconvert {escape(filepath)} --output {escape(str(output_filepath))} --execute {'' if theme is None else ('--template=' + theme[0])} --to slides --no-input --no-prompt{'' if not serve else ' --post serve'} --SlidesExporter.reveal_scroll=True --SlidesExporter.reveal_number=c/t --SlidesExporter.reveal_theme={'simple' if light else 'night'} {'' if theme is None else ('--TemplateExporter.extra_template_basedirs=' + theme[1])}",
+            args=f"_NBCONVERT_OUTPUT_FORMAT=slides jupyter nbconvert {escape(filepath)} --output {escape(str(output_filepath))} --execute {'' if theme is None else ('--template=' + theme[0])} --to slides --no-input --no-prompt{'' if not serve else ' --post serve'} --SlidesExporter.reveal_scroll=True --SlidesExporter.reveal_number=c/t --SlidesExporter.reveal_theme={'simple' if light else 'night'} {'' if theme is None else ('--TemplateExporter.extra_template_basedirs=' + theme[1])}",
             shell=True,
         )
 

{mayutils-1.0.89 → mayutils-1.2.0}/src/mayutils/interfaces/google.py

@@ -1050,7 +1050,8 @@ class Sheet(object):
 
         return self.update_values(
             range=f"{self.title}!{'A1' if range is None else range}",
-            values=[df_with_index.columns.to_list()] + df_with_index.to_numpy().tolist(),  # type: ignore
+            values=[df_with_index.columns.to_list()]
+            + df_with_index.to_numpy().tolist(),  # type: ignore
             as_user=as_user,
         )
 

mayutils-1.2.0/src/mayutils/mathematics/__init__.py

@@ -0,0 +1,15 @@
+from typing import get_args, Literal
+
+type Scale = Literal["relative", "absolute", "percentage"]
+type Operation = Literal[
+    "division",
+    "normalise",
+    "standardise",
+    "dot_product",
+    "inverse",
+    "constant",
+    "drop",
+]
+type Calculations = dict[Operation, dict[str, tuple[str, ...]]]
+
+OPERATIONS: tuple = get_args(Operation.__value__)

{mayutils-1.0.89 → mayutils-1.2.0}/src/mayutils/objects/colours.py

@@ -10,6 +10,77 @@ from mayutils.objects.classes import (
 reverse_colourmap: dict[str, str] = {value: key for key, value in colormap.items()}  # type: ignore
 
 
+MAIN_COLOURSCALE = dict(
+    quartz="#FFCCFF",
+    pink="#FF97FF",
+    bubblegum="#FF85FF",
+    cherry="#FF6692",
+    red="#EF553B",
+    copper="#CF4915",
+    coral="#FFA15A",
+    orange="#FF9C12",
+    peach="#FFBD8E",
+    amber="#FECB52",
+    yellow="#FFE989",
+    lime="#B6E880",
+    green="#3BDB5F",
+    teal="#00cc96",
+    mint="#73DBB6",
+    cyan="#30D5DB",
+    sky="#19d3f3",
+    blue="#636efa",
+    periwinkle="#9299FD",
+    purple="#ab63fa",
+    mauve="#C592FD",
+    lavender="#DEBFFF",
+)
+SIMPLE_COLOURS = dict(
+    lightgreen="#73DBB6",
+    darkgreen="#3BDB5F",
+    cyan="#30D5DB",
+    blue="#9299FD",
+    yellow="#FFE989",
+    orange="#FFBD8E",
+    red="#F58B78",
+    purple="#C592FD",
+    lightpink="#FFCCFF",
+    pink="#FF85FF",
+)
+BASE_COLOURSCALE = list(MAIN_COLOURSCALE.values())
+CONTINUOUS_COLORSCALE = [
+    [0.0, "#0d0887"],
+    [0.1111111111111111, "#46039f"],
+    [0.2222222222222222, "#7201a8"],
+    [0.3333333333333333, "#9c179e"],
+    [0.4444444444444444, "#bd3786"],
+    [0.5555555555555556, "#d8576b"],
+    [0.6666666666666666, "#ed7953"],
+    [0.7777777777777778, "#fb9f3a"],
+    [0.8888888888888888, "#fdca26"],
+    [1.0, "#f0f921"],
+]
+DIVERGENT_COLOURSCALE = [
+    [0, "#8e0152"],
+    [0.1, "#c51b7d"],
+    [0.2, "#de77ae"],
+    [0.3, "#f1b6da"],
+    [0.4, "#fde0ef"],
+    [0.5, "#f7f7f7"],
+    [0.6, "#e6f5d0"],
+    [0.7, "#b8e186"],
+    [0.8, "#7fbc41"],
+    [0.9, "#4d9221"],
+    [1, "#276419"],
+]
+
+OPACITIES = {
+    "primary": 1.0,
+    "secondary": 0.5,
+    "tertiary": 0.4,
+    "quaternary": 0.3,
+}
+
+
 @dataclass
 class Colour:
     r: float
@@ -82,7 +153,7 @@ class Colour:
 
     def _html_show(
         self,
-        size: int=50,
+        size: int = 50,
     ) -> str:
         return f'<div style="width:{size}px;height:{size}px;background-color:{self.to_str()};"></div>'
 
@@ -260,3 +331,9 @@ def hex_to_rgba(
         return f"rgba({values[0]}, {values[1]}, {values[2]}, {alpha})"
     else:
         raise ValueError("Invalid hex colour format. Use #RRGGBB or #RRGGBBAA")
+
+
+TRANSPARENT = Colour.parse(colour="rgba(0,0,0,0)")
+SPECTRUM = {
+    name: Colour.parse(colour=colour) for name, colour in MAIN_COLOURSCALE.items()
+}