onekit 2.0.0__tar.gz → 2.1.1__tar.gz

{onekit-2.0.0 → onekit-2.1.1}/LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2024 Eugen Stripling
+Copyright (c) 2023-2025 Eugen Stripling
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

{onekit-2.0.0 → onekit-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: onekit
-Version: 2.0.0
+Version: 2.1.1
 Summary: All-in-One Python Kit.
 License: BSD 3-Clause
 Keywords: onekit
@@ -9,8 +9,16 @@ Author-email: estripling042@gmail.com
 Requires-Python: >=3.11
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: pytz (>=2025.1,<2026.0)
-Requires-Dist: toolz (>=1.0.0,<2.0.0)
+Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: analytics
+Provides-Extra: base
+Provides-Extra: pyspark
+Requires-Dist: pandas[compression,computation,excel,output-formatting,parquet,performance,plot] (>=2.2.3,<3.0.0) ; extra == "analytics"
+Requires-Dist: pyspark (==3.5.3) ; extra == "pyspark"
+Requires-Dist: pytz (>=2025.2,<2026.0) ; extra == "base"
+Requires-Dist: scikit-learn (>=1.6.1,<2.0.0) ; extra == "analytics"
+Requires-Dist: toolz (>=1.0.0,<2.0.0) ; extra == "base"
+Requires-Dist: tqdm (>=4.67.1,<5.0.0) ; extra == "analytics"
 Description-Content-Type: text/markdown
 
 <p align="center">
@@ -39,10 +47,16 @@ All-in-One Python Kit:
 
 `onekit` is available on [PyPI](https://pypi.org/project/onekit/) for Python 3.11+:
 
-```console
+```shell
 pip install onekit
 ```
 
+With optional dependencies:
+
+```shell
+pip install onekit[base,analytics,pyspark]
+```
+
 ## Disclaimer
 
 ⚠️ This is a personal project: Use at your own risk!

{onekit-2.0.0 → onekit-2.1.1}/README.md

@@ -24,10 +24,16 @@ All-in-One Python Kit:
 
 `onekit` is available on [PyPI](https://pypi.org/project/onekit/) for Python 3.11+:
 
-```console
+```shell
 pip install onekit
 ```
 
+With optional dependencies:
+
+```shell
+pip install onekit[base,analytics,pyspark]
+```
+
 ## Disclaimer
 
 ⚠️ This is a personal project: Use at your own risk!

{onekit-2.0.0 → onekit-2.1.1}/pyproject.toml

@@ -13,32 +13,40 @@ keywords = ["onekit"]
 packages = [
     { include = "onekit", from = "src" },
 ]
-requires-python = ">=3.11"
-dependencies = [
-    "toolz (>=1.0.0,<2.0.0)",
-    "pytz (>=2025.1,<2026.0)",
-]
 classifiers = [
     "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
 ]
+requires-python = ">=3.11"
+dependencies = []
 
 [tool.poetry]
-version = "2.0.0"
+version = "2.1.1"
 
-[tool.poetry.group.precommit.dependencies]
-autoflake = "^2.2.1"
-black = { extras = ["jupyter"], version = "^23.11.0" }
-isort = "^5.12.0"
-flake8 = ">=5.0.4"
-pre-commit = "^3.5.0"
-pre-commit-hooks = "^4.5.0"
+[project.optional-dependencies]
+base = [
+    "toolz (>=1.0.0,<2.0.0)",
+    "pytz (>=2025.2,<2026.0)",
+]
+analytics = [
+    "pandas[compression,computation,excel,output-formatting,parquet,performance,plot] (>=2.2.3,<3.0.0)",
+    "scikit-learn (>=1.6.1,<2.0.0)",
+    "tqdm (>=4.67.1,<5.0.0)",
+]
+pyspark = ["pyspark (==3.5.3)"]
 
-[tool.poetry.group.testing.dependencies]
-pytest = "^7.4.3"
-pytest-cov = "^4.1.0"
+[tool.poetry.group.dev.dependencies]
+autoflake = "^2.3.1"
+black = { extras = ["jupyter"], version = "^25.1.0" }
+isort = "^6.0.1"
+flake8 = "^7.1.2"
+pre-commit = "^4.2.0"
+pre-commit-hooks = "^5.0.0"
+pytest = "^8.3.5"
+pytest-cov = "^6.0.0"
 pytest-skip-slow = "^0.0.5"
-time-machine = "^2.13.0"
+time-machine = "^2.16.0"
 
 [tool.poetry.group.docs.dependencies]
 furo = "^2023.9.10"
@@ -47,27 +55,11 @@ myst-parser = "^2.0.0"
 nbsphinx = "^0.9.3"
 sphinx-autoapi = "^3.0.0"
 sphinx-copybutton = "^0.5.2"
+time-machine = "^2.16.0"
 
 [tool.poetry.group.packaging.dependencies]
 python-semantic-release = "^8.3.0"
 
-[tool.poetry.group.dekit.dependencies]
-numpy = "1.26.4"
-tqdm = "^4.67.1"
-
-[tool.poetry.group.pandaskit.dependencies]
-pandas = ">=0.23.2"
-tabulate = "^0.9.0"
-
-[tool.poetry.group.sklearnkit.dependencies]
-scikit-learn = ">=1.3"
-
-[tool.poetry.group.sparkkit.dependencies]
-pyspark = "3.5.3"
-
-[tool.poetry.group.vizkit.dependencies]
-matplotlib = ">=3.7.1"
-
 [tool.black]
 line-length = 88
 

{onekit-2.0.0 → onekit-2.1.1}/src/onekit/dekit.py

@@ -18,8 +18,8 @@ from typing import (
 import numpy as np
 import toolz
 
-import onekit.numpykit as npk
-import onekit.pythonkit as pk
+from onekit import numpykit as npk
+from onekit import pythonkit as pk
 
 Bounds = list[tuple[float, float]]
 Seed = int | float | random.Random | np.random.RandomState | np.random.Generator | None
@@ -125,10 +125,8 @@ class KeyFunction:
 
     @staticmethod
     def neg_inf():
-        return (
-            lambda ind: -float("inf")
-            if ind.fx is None or not np.isfinite(ind.fx)
-            else ind.fx
+        return lambda ind: (
+            -float("inf") if ind.fx is None or not np.isfinite(ind.fx) else ind.fx
         )
 
 

{onekit-2.0.0 → onekit-2.1.1}/src/onekit/mathkit.py

@@ -59,7 +59,7 @@ def collatz(n: int, /) -> Generator:
     Examples
     --------
     >>> import toolz
-    >>> import onekit.mathkit as mk
+    >>> from onekit import mathkit as mk
     >>> n = 12
     >>> list(mk.collatz(n))
     [12, 6, 3, 10, 5, 16, 8, 4, 2, 1]
@@ -125,7 +125,7 @@ def digitscale(x: int | float, /, *, kind: str = "log") -> int | float:
 
     Examples
     --------
-    >>> import onekit.mathkit as mk
+    >>> from onekit import mathkit as mk
     >>> list(map(mk.digitscale, [0.1, 1, 10, 100, 1_000, 10_000, 100_000, 1_000_000]))
     [0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0]
 
@@ -196,7 +196,7 @@ def fibonacci() -> Generator:
     Examples
     --------
     >>> import toolz
-    >>> import onekit.mathkit as mk
+    >>> from onekit import mathkit as mk
     >>> list(toolz.take(13, mk.fibonacci()))
     [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144]
     """
@@ -216,7 +216,7 @@ def isdivisible(x: int | float, /, n: int) -> bool:
     Examples
     --------
     >>> from functools import partial
-    >>> import onekit.mathkit as mk
+    >>> from onekit import mathkit as mk
     >>> mk.isdivisible(49, 7)
     True
 
@@ -237,7 +237,7 @@ def iseven(x: int | float, /) -> bool:
 
     Examples
     --------
-    >>> import onekit.mathkit as mk
+    >>> from onekit import mathkit as mk
     >>> mk.iseven(0)
     True
 
@@ -255,7 +255,7 @@ def isodd(x: int | float, /) -> bool:
 
     Examples
     --------
-    >>> import onekit.mathkit as mk
+    >>> from onekit import mathkit as mk
     >>> mk.isodd(0)
     False
 
@@ -282,7 +282,7 @@ def sign(x: int | float, /) -> int:
 
     Examples
     --------
-    >>> import onekit.mathkit as mk
+    >>> from onekit import mathkit as mk
     >>> mk.sign(0)
     0
 

{onekit-2.0.0 → onekit-2.1.1}/src/onekit/numpykit.py

@@ -3,7 +3,7 @@ import random
 import numpy as np
 import numpy.typing as npt
 
-import onekit.mathkit as mk
+from onekit import mathkit as mk
 
 __all__ = (
     "check_random_state",
@@ -24,7 +24,7 @@ def check_random_state(seed: Seed = None) -> np.random.Generator:
     Examples
     --------
     >>> import numpy as np
-    >>> import onekit.numpykit as npk
+    >>> from onekit import numpykit as npk
     >>> rng = npk.check_random_state()
     >>> isinstance(rng, np.random.Generator)
     True
@@ -73,7 +73,7 @@ def check_vector(x: ArrayLike, /, *, n_min: int = 1, n_max: int = np.inf) -> Vec
 
     Examples
     --------
-    >>> import onekit.numpykit as npk
+    >>> from onekit import numpykit as npk
     >>> npk.check_vector([0, 0])
     array([0, 0])
     """
@@ -101,7 +101,7 @@ def digitscale(x: ArrayLike, /, *, kind: str = "log") -> np.ndarray:
 
     Examples
     --------
-    >>> import onekit.numpykit as npk
+    >>> from onekit import numpykit as npk
     >>> npk.digitscale([0.1, 1, 10, 100, 1_000, 10_000, 2_000_000])
     array([0.     , 1.     , 2.     , 3.     , 4.     , 5.     , 7.30103])
 
@@ -121,7 +121,8 @@ def stderr(x: ArrayLike, /) -> float:
     Examples
     --------
     >>> import numpy as np
-    >>> import onekit.numpykit as npk
+    >>> from onekit import numpykit as npk
+    >>> np.set_printoptions(legacy="1.21")
     >>> round(npk.stderr([98, 127, 82, 67, 121, np.nan, 119, 92, 110, 113, 107]), 4)
     5.9632
     """

{onekit-2.0.0 → onekit-2.1.1}/src/onekit/optfunckit.py

@@ -7,6 +7,7 @@ References
 .. [wiki] "Test functions for optimization", Wikipedia,
     `<https://en.wikipedia.org/wiki/Test_functions_for_optimization>`_
 """
+
 from typing import (
     Callable,
     NamedTuple,
@@ -16,8 +17,8 @@ import numpy as np
 import numpy.typing as npt
 import toolz
 
-import onekit.numpykit as npk
-import onekit.vizkit as vk
+from onekit import numpykit as npk
+from onekit import vizkit as vk
 
 __all__ = (
     "ackley",
@@ -69,7 +70,7 @@ def ackley(x: Vector, /) -> float:
 
     Examples
     --------
-    >>> import onekit.optfunckit as ofk
+    >>> from onekit import optfunckit as ofk
     >>> round(ofk.ackley([0, 0]), 4)
     0.0
 
@@ -109,7 +110,7 @@ def beale(x: Vector, /) -> float:
 
     Examples
     --------
-    >>> import onekit.optfunckit as ofk
+    >>> from onekit import optfunckit as ofk
     >>> ofk.beale([3, 0.5])
     0.0
 
@@ -152,7 +153,7 @@ def bump(x: Vector, /) -> float:
 
     Examples
     --------
-    >>> import onekit.optfunckit as ofk
+    >>> from onekit import optfunckit as ofk
     >>> round(ofk.bump([0, 0]), 4)
     -0.3679
 
@@ -172,7 +173,7 @@ def fetch_minima(func: Callable, /, n: int) -> list[Minimum] | None:
 
     Examples
     --------
-    >>> import onekit.optfunckit as ofk
+    >>> from onekit import optfunckit as ofk
     >>> sphere_minima_n5 = ofk.fetch_minima(ofk.sphere, 5)
     >>> sphere_minima_n5
     [Minimum(x=array([0, 0, 0, 0, 0]), fx=0)]
@@ -317,13 +318,13 @@ def negate(fx: float) -> float:
 
     Examples
     --------
-    >>> import onekit.optfunckit as ofk
+    >>> from onekit import optfunckit as ofk
     >>> ofk.negate(1.0)
     -1.0
 
     >>> # transform into a maximization problem
     >>> import toolz
-    >>> import onekit.optfunckit as ofk
+    >>> from onekit import optfunckit as ofk
     >>> problem = toolz.compose_left(ofk.ackley, ofk.negate)
     >>> round(problem([0, 0]), 4)
     0.0
@@ -362,7 +363,7 @@ def peaks(x: Vector, /) -> float:
 
     Examples
     --------
-    >>> import onekit.optfunckit as ofk
+    >>> from onekit import optfunckit as ofk
     >>> round(ofk.peaks([0, 0]), 4)
     0.981
     """
@@ -387,7 +388,7 @@ def rastrigin(x: Vector, /) -> float:
 
     Examples
     --------
-    >>> import onekit.optfunckit as ofk
+    >>> from onekit import optfunckit as ofk
     >>> round(ofk.rastrigin([0, 0]), 4)
     0.0
 
@@ -420,7 +421,7 @@ def rosenbrock(x: Vector, /) -> float:
 
     Examples
     --------
-    >>> import onekit.optfunckit as ofk
+    >>> from onekit import optfunckit as ofk
     >>> round(ofk.rosenbrock([0, 0]), 4)
     1.0
 
@@ -459,7 +460,7 @@ def schwefel(x: Vector, /) -> float:
 
     Examples
     --------
-    >>> import onekit.optfunckit as ofk
+    >>> from onekit import optfunckit as ofk
     >>> round(ofk.schwefel([420.9687]), 4)
     0.0
 
@@ -499,7 +500,7 @@ def sinc(x: Vector, /) -> float:
 
     Examples
     --------
-    >>> import onekit.optfunckit as ofk
+    >>> from onekit import optfunckit as ofk
     >>> ofk.sinc([0])
     -1.0
 
@@ -522,7 +523,7 @@ def sphere(x: Vector, /) -> float:
 
     Examples
     --------
-    >>> import onekit.optfunckit as ofk
+    >>> from onekit import optfunckit as ofk
     >>> ofk.sphere([0, 0])
     0.0
 

{onekit-2.0.0 → onekit-2.1.1}/src/onekit/pandaskit.py

@@ -10,7 +10,7 @@ import toolz
 from pandas import DataFrame as PandasDF
 from tabulate import tabulate
 
-import onekit.pythonkit as pk
+from onekit import pythonkit as pk
 
 __all__ = (
     "cvf",
@@ -29,7 +29,7 @@ def cvf(*cols: str | Iterable[str]) -> PandasDFPipeFunc:
     Examples
     --------
     >>> import pandas as pd
-    >>> import onekit.pandaskit as pdk
+    >>> from onekit import pandaskit as pdk
     >>> df = pd.DataFrame({"x": ["a", "c", "b", "g", "h", "a", "g", "a"]})
     >>> df.pipe(pdk.cvf("x"))
        x  count  percent  cumul_count  cumul_percent
@@ -66,7 +66,7 @@ def cvf(*cols: str | Iterable[str]) -> PandasDFPipeFunc:
 
 def display(
     df: PandasDF,
-    caption: str | None = None,
+    label: str | None = None,
     na_rep: str | None = "NULL",
     drop_original_index: bool = True,
     with_row_numbers: bool = True,
@@ -76,7 +76,7 @@ def display(
     Examples
     --------
     >>> import pandas as pd
-    >>> import onekit.pandaskit as pdk
+    >>> from onekit import pandaskit as pdk
     >>> df = pd.DataFrame([dict(x=1, y=2), dict(x=3, y=4), dict(x=None, y=6)])
     >>> pdk.display(df)
     +----+------+-----+
@@ -89,7 +89,7 @@ def display(
     |  3 | NULL |   6 |
     +----+------+-----+
     """
-    with_caption = caption is not None
+    with_label = label is not None
 
     def print_tabulated_df() -> None:
         tabulated_df = tabulate(
@@ -100,9 +100,9 @@ def display(
             intfmt="_g",
             missingval=na_rep,
         )
-        if with_caption:
+        if with_label:
             n = max(map(len, tabulated_df.splitlines()))
-            print(pk.headline(caption, n=n, fillchar="="))
+            print(pk.headline(label, n=n, fillchar="="))
         print(tabulated_df)
 
     if with_row_numbers:
@@ -116,9 +116,9 @@ def display(
     try:
         from IPython.display import display as notebook_display
 
-        df_style = df.style.set_caption(caption) if with_caption else df.style
+        df_style = df.style.set_caption(label) if with_label else df.style
         table_styles = []
-        if with_caption:
+        if with_label:
             table_styles.append(
                 dict(
                     selector="caption",
@@ -160,7 +160,7 @@ def join(
     Examples
     --------
     >>> import pandas as pd
-    >>> import onekit.pandaskit as pdk
+    >>> from onekit import pandaskit as pdk
     >>> df1 = pd.DataFrame([dict(a=1, b=3), dict(a=2, b=4)])
     >>> df2 = pd.DataFrame([dict(a=1, c=5), dict(a=2, c=6)])
     >>> df3 = pd.DataFrame([dict(a=1, d=7)])
@@ -182,7 +182,7 @@ def profile(df: PandasDF, /, *, q: list[int] | None = None) -> PandasDF:
     Examples
     --------
     >>> import pandas as pd
-    >>> import onekit.pandaskit as pdk
+    >>> from onekit import pandaskit as pdk
     >>> data = {
     ...     "a": [True, None, False, False, True, False],
     ...     "b": [1] * 6,
@@ -256,7 +256,7 @@ def union(*dataframes: PandasDF | Iterable[PandasDF]) -> PandasDF:
     Examples
     --------
     >>> import pandas as pd
-    >>> import onekit.pandaskit as pdk
+    >>> from onekit import pandaskit as pdk
     >>> df1 = pd.DataFrame([dict(x=1, y=2), dict(x=3, y=4)])
     >>> df2 = pd.DataFrame([dict(x=5, y=6), dict(x=7, y=8)])
     >>> df3 = pd.DataFrame([dict(x=0, y=1), dict(x=2, y=3)])