analog-daddy 3.0.0b1__tar.gz → 3.0.1.dev2__tar.gz

{analog_daddy-3.0.0b1 → analog_daddy-3.0.1.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: analog-daddy
-Version: 3.0.0b1
+Version: 3.0.1.dev2
 Summary: This library is an attempt to make transistor sizing for Analog Design less painful. Additionally, provides helper utilities to minimize churn and errors in repetative tasks.
 Author: Siddhant Laddha
 Author-email: Siddhant Laddha <25705822+siddhantladdha@users.noreply.github.com>
@@ -23,7 +23,7 @@ Requires-Dist: scipy
 Requires-Dist: xarray
 Maintainer: Siddhant Laddha
 Maintainer-email: Siddhant Laddha <25705822+siddhantladdha@users.noreply.github.com>
-Requires-Python: >=3.14, <3.15
+Requires-Python: >=3.12
 Project-URL: bugs, https://github.com/siddhantladdha/analog_daddy/issues
 Project-URL: changelog, https://github.com/siddhantladdha/analog_daddy/releases
 Project-URL: documentation, https://siddhantladdha.github.io/analog_daddy/

analog_daddy-3.0.1.dev2/pyproject.toml

@@ -0,0 +1,157 @@
+[project]
+name = "analog-daddy"
+version = "3.0.1.dev2"
+description = "This library is an attempt to make transistor sizing for Analog Design less painful. Additionally, provides helper utilities to minimize churn and errors in repetative tasks."
+readme = "README.md"
+requires-python = ">= 3.12"
+license = "MIT"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Education",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
+    "Typing :: Typed",
+]
+dependencies = [
+    "boltons",
+    "cyclopts; sys_platform != 'emscripten'",
+    "great-tables",
+    "plotly",
+    "polars",
+    "pydantic>=2",
+    "pydantic-settings",
+    "quantiphy",
+    "rich",
+    "scipy",
+    "xarray",
+]
+
+[[project.authors]]
+name = "Siddhant Laddha"
+email = "25705822+siddhantladdha@users.noreply.github.com"
+
+[[project.maintainers]]
+name = "Siddhant Laddha"
+email = "25705822+siddhantladdha@users.noreply.github.com"
+
+[project.urls]
+bugs = "https://github.com/siddhantladdha/analog_daddy/issues"
+changelog = "https://github.com/siddhantladdha/analog_daddy/releases"
+documentation = "https://siddhantladdha.github.io/analog_daddy/"
+homepage = "https://github.com/siddhantladdha/analog_daddy"
+
+[project.scripts]
+analog_daddy = "analog_daddy.cli:app"
+
+[dependency-groups]
+dev = [
+    "format-docstring",
+    "hypothesis",
+    "pytest",
+    "ruff",
+    "ty",
+]
+docs = [
+    "mkdocstrings-python",
+    "nbconvert",
+    "playwright",
+    "zensical",
+]
+lint = ["pydoclint"]
+notebooks = [
+    "marimo[lsp,mcp,recommended]",
+    "wigglystuff",
+]
+
+[[dependency-groups.all]]
+include-group = "dev"
+
+[[dependency-groups.all]]
+include-group = "docs"
+
+[[dependency-groups.all]]
+include-group = "notebooks"
+
+[build-system]
+requires = ["uv_build>=0.13.0,<0.14"]
+build-backend = "uv_build"
+
+[tool.format_docstring]
+docstring_style = "numpy"
+line_length = 72
+include_arg_types = true
+include_arg_defaults = true
+fix_rst_backticks = true
+exclude = '\.git|\.venv|__pycache__|.*drafts.*\.py'
+
+[tool.pydoclint]
+style = "numpy"
+arg-type-hints-in-docstring = true
+arg-type-hints-in-signature = true
+check-return-types = true
+check-arg-defaults = true
+check-style-mismatch = true
+show-filenames-in-every-violation-message = true
+exclude = '\.git|\.tox|\.venv|build|dist|.*drafts.*\.py'
+
+[tool.pytest.ini_options]
+addopts = [
+    "--doctest-modules",
+    "--ignore-glob=*drafts*.py",
+]
+doctest_optionflags = ["IGNORE_EXCEPTION_DETAIL"]
+testpaths = [
+    "src",
+    "tests",
+]
+
+[tool.ruff]
+line-length = 79
+extend-exclude = ["*drafts*.py"]
+output-prefer-rule-codes = true
+
+[tool.ruff.lint]
+ignore = [
+    "D105",
+    "D401",
+]
+extend-select = [
+    "NPY",
+    "N",
+    "PTH",
+    "SIM",
+    "EXE",
+    "FURB110",
+    "FURB116",
+    "FURB167",
+    "FURB177",
+    "B903",
+    "TRY300",
+    "LOG004",
+    "LOG007",
+    "UP042",
+    "PERF403",
+    "PERF401",
+    "FURB113",
+    "FURB152",
+    "FURB156",
+]
+preview = true
+explicit-preview-rules = true
+external = ["DOC105"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.ty.src]
+exclude = ["**/*drafts*.py"]
+
+[tool.ty.terminal]
+output-format = "concise"
+
+[tool.uv]
+default-groups = ["all"]
+required-version = ">=0.13.0,<0.14"

analog_daddy-3.0.0b1/pyproject.toml → analog_daddy-3.0.1.dev2/pyproject.toml.orig

@@ -1,9 +1,9 @@
 [project]
 name = "analog-daddy"
-version = "3.0.0b1"
+version = "3.0.1.dev2"
 description = "This library is an attempt to make transistor sizing for Analog Design less painful. Additionally, provides helper utilities to minimize churn and errors in repetative tasks."
 readme = "README.md"
-requires-python = ">= 3.14, < 3.15"  # TODO: Review if 3.12 can be supported.
+requires-python = ">= 3.12"
 license = "MIT"
 authors = [
   { name = "Siddhant Laddha", email = "25705822+siddhantladdha@users.noreply.github.com" }
@@ -43,6 +43,8 @@ analog_daddy = "analog_daddy.cli:app"
 
 [dependency-groups]
 dev = [
+  "format-docstring",
+  "hypothesis",
   "pytest",
   "ruff",
   "ty",
@@ -57,26 +59,50 @@ docs = [
   "nbconvert",  # marimo pdf exports.
   "playwright",  # marimo pdf exports.
   "zensical",
+  # TODO: evaluate vs great-docs for marimo notebooks in docs.
 ]
+lint = ["pydoclint"]
 notebooks = [
   "marimo[lsp,mcp,recommended]",
   "wigglystuff",
 ]
 
 [build-system]
-requires = ["uv_build>=0.11.0,<0.12.0"]
+requires = ["uv_build>=0.13.0,<0.14"]
 build-backend = "uv_build"
 
+[tool.format_docstring]
+docstring_style = "numpy"
+line_length = 72
+include_arg_types = true
+include_arg_defaults = true
+fix_rst_backticks = true
+exclude = "\\.git|\\.venv|__pycache__|.*drafts.*\\.py"
+
+[tool.pydoclint]
+# issue #313 currently needs # noqa: DOC105
+style = "numpy"
+arg-type-hints-in-docstring = true
+arg-type-hints-in-signature = true
+check-return-types = true
+check-arg-defaults = true
+check-style-mismatch = true
+show-filenames-in-every-violation-message = true
+exclude = '\.git|\.tox|\.venv|build|dist|.*drafts.*\.py'
+
 [tool.pytest.ini_options]
-addopts = ["--doctest-modules"]
+addopts = ["--doctest-modules", "--ignore-glob=*drafts*.py"]
+doctest_optionflags = ["IGNORE_EXCEPTION_DETAIL"]
 testpaths = ["src", "tests"]
 
 [tool.ruff]
-line-length = 120
-extend-exclude = ["archives", "drafts"]
+line-length = 79
+extend-exclude = ["*drafts*.py"]
+output-prefer-rule-codes = true
 
 [tool.ruff.lint]
 ignore = [
+  # "DOC",  # pydoclint is already handling docstring issues.
   # "F401",  # F401: module imported but unused
   # "D100",  # Missing docstring in public module"
   # "D103",  # undocumented-public-method
@@ -85,7 +111,7 @@ ignore = [
 ]
 extend-select = [
   "NPY",  # numpy
-  "D",  # docstring # needs convention
+  # "D",  # docstring # handled by format-docstring and pydoclint
   "N",  # pep8-naming
   "PTH",  # flake8-use-pathlib
   "SIM",  # flake8-simplify
@@ -116,6 +142,7 @@ extend-select = [
 # There are certain `preview`/beta rules that I am selectively enabling.
 preview = true
 explicit-preview-rules = true
+external = ["DOC105"]
 
 [tool.ruff.lint.pydocstyle]
 convention = "numpy"
@@ -124,10 +151,12 @@ convention = "numpy"
 docstring-code-format = true
 
 [tool.ty]
-# All rules are enabled as "error" by default; no need to specify unless overriding.
-# Example override: relax a rule for the entire project (uncomment if needed).
-# rules.TY015 = "warn"  # For invalid-argument-type, warn instead of error.
+[tool.ty.src]
+exclude = ["**/*drafts*.py"]
+
+[tool.ty.terminal]
+output-format = "concise"
 
 [tool.uv]
 default-groups = ["all"]
-required-version = "==0.11.0"
+required-version = ">=0.13.0,<0.14"

analog_daddy-3.0.1.dev2/src/analog_daddy/__init__.py

@@ -0,0 +1,5 @@
+"""Top-level package for Analog Daddy."""
+
+from importlib.metadata import version
+
+__version__ = version("analog-daddy")

{analog_daddy-3.0.0b1 → analog_daddy-3.0.1.dev2}/src/analog_daddy/cli.py

@@ -10,8 +10,12 @@ console = Console()
 @app.default
 def main() -> None:
     """Console script for analog_daddy."""
-    console.print("Replace this message by putting your code into analog_daddy.cli.main")
-    console.print("See Cyclopts documentation at https://cyclopts.readthedocs.io/")
+    console.print(
+        "Replace this message by putting your code into analog_daddy.cli.main"
+    )
+    console.print(
+        "See Cyclopts documentation at https://cyclopts.readthedocs.io/"
+    )
 
 
 if __name__ == "__main__":

analog_daddy-3.0.1.dev2/src/analog_daddy/gtutils.py

@@ -0,0 +1,8 @@
+import polars.selectors as cs
+from great_tables import GT
+
+
+def gt_defaults(gtbl: GT):
+    """Preferred defaults for rendering great tables."""
+    gtbl = gtbl.fmt_number_si(columns=cs.numeric()).opt_stylize(style=4)
+    return gtbl

analog_daddy-3.0.1.dev2/src/analog_daddy/mootils.py

@@ -0,0 +1,156 @@
+"""
+A collection of marimo utility functions.
+
+While marimo is quite feature-rich, these functions are intended to be
+convenience functions for common tasks that are not yet implemented in
+marimo. These might be deprecated if they become available in marimo.
+"""
+
+import io
+from collections.abc import Callable
+from typing import Any
+
+import marimo as mo
+import polars as pl
+import polars.selectors as cs
+from rich.console import Console, RenderableType
+from wigglystuff import CopyToClipboard
+
+from analog_daddy.utils import render
+
+
+def format_mapping_num_to_si(df: pl.DataFrame) -> dict[str, Callable]:
+    """
+    Build a format mapping that renders numeric columns as SI strings.
+
+    Intended for the ``format_mapping`` argument of ``mo.ui.table`` and
+    ``mo.ui.dataframe``. Columns are matched with ``cs.numeric()`` and
+    rendered with :func:`render`.
+
+    Parameters
+    ----------
+    df : pl.DataFrame
+        DataFrame whose numeric columns to map.
+
+    Returns
+    -------
+    dict[str, Callable]
+        Column name to formatter mapping.
+
+    References
+    ----------
+    - [marimo#9663](https://github.com/marimo-team/marimo/issues/9663)
+    - [marimo#7568](https://github.com/marimo-team/marimo/issues/7568)
+    """
+    return dict.fromkeys(cs.expand_selector(df, cs.numeric()), render)
+
+
+def mo_table(
+    data: pl.DataFrame,
+    *,
+    selection=None,
+    pagination=None,
+    page_size=30,
+    max_columns=1000,
+    **kwargs,
+) -> mo.ui.table:
+    kwargs.setdefault("format_mapping", format_mapping_num_to_si(data))
+    return mo.ui.table(
+        data,
+        selection=selection,
+        pagination=pagination,
+        page_size=page_size,
+        max_columns=max_columns,
+        **kwargs,
+    )
+
+
+def rich_md(
+    *renderables: RenderableType,
+    console_kwargs: dict[str, Any] | None = None,
+    print_kwargs: dict[str, Any] | None = None,
+    export_html_kwargs: dict[str, Any] | None = None,
+) -> mo.Html:
+    """
+    A minimal helper function to utilize rich markup within marimo.
+
+    Created this for shits-n-giggles. This is in no way complete! I
+    don't use this as much as I would like to, however, in case you have
+    some text, that you would like to keep consistent with your console
+    markup, this might be an option.
+
+    Parameters
+    ----------
+    *renderables : RenderableType
+        The renderable objects to be printed using rich.
+    console_kwargs : dict[str, Any] | None, default=None
+        Keyword arguments to customize the rich Console.
+    print_kwargs : dict[str, Any] | None, default=None
+        Keyword arguments to customize the rich print method.
+    export_html_kwargs : dict[str, Any] | None, default=None
+        Keyword arguments to customize the rich export_html method.
+
+    Returns
+    -------
+    mo.Html
+        The HTML representation of the rich renderables.
+
+    Examples
+    --------
+    >>> "font-weight: bold" in rich_md("[bold green]Hello[/] World").text
+    True
+    >>> "font-style: italic" in rich_md(
+    ...     "[bold]Bold[italic] bold and italic [/bold]italic[/italic]"
+    ... ).text
+    True
+    >>> "⚠️" in rich_md(":warning-emoji: you have been warned!").text
+    True
+    """
+    console_kwargs = {
+        "color_system": "truecolor",
+        "record": True,
+        **(console_kwargs or {}),
+    }
+    print_kwargs = print_kwargs or {}
+    export_html_kwargs = {
+        "inline_styles": True,
+        "code_format": "{code}",
+        **(export_html_kwargs or {}),
+    }
+
+    capture = io.StringIO()
+    console = Console(file=capture, **console_kwargs)
+    console.print(*renderables, **print_kwargs)
+    return mo.Html(console.export_html(**export_html_kwargs))
+
+
+def df_repr_docstr_clip(
+    df: pl.DataFrame, max_rows: int = 3
+) -> CopyToClipboard:
+    """
+    Copy the repr of a polars DataFrame to the clipboard.
+
+    Parameters
+    ----------
+    df : pl.DataFrame
+        The DataFrame to copy the repr of.
+    max_rows : int, default=3
+        The maximum number of rows to include in the repr.
+
+    Returns
+    -------
+    CopyToClipboard
+        A CopyToClipboard object containing the repr of the DataFrame.
+
+    Examples
+    --------
+    >>> a = pl.DataFrame(
+    ...     {"x": [9.0, 11.0], "foo": [10.0, 10.0], "bar": [5.0, 5.0]},
+    ... )
+    >>> df_repr_docstr_clip(a).text_to_copy.startswith("shape: (2, 3)")
+    True
+    """
+
+    return CopyToClipboard(
+        text_to_copy=df.slice(offset=0, length=max_rows).__repr__(),
+    )