flatbread 0.1.0__tar.gz → 0.1.2__tar.gz

{flatbread-0.1.0 → flatbread-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flatbread
-Version: 0.1.0
+Version: 0.1.2
 Summary: Pandas extension for aggregation and tabular display
 Project-URL: Homepage, https://github.com/lcvriend/flatbread
 Author-email: "L.C. Vriend" <vanboefer@gmail.com>
@@ -695,20 +695,18 @@ Requires-Dist: jinja2
 Requires-Dist: pandas>=2.0.0
 Description-Content-Type: text/markdown
 
-Here's a concise README for flatbread:
-
-```markdown
 # Flatbread
 
-Flatbread is a Python library that extends pandas with tabulation features through a chainable API. It makes it easy to create summary tables with totals, subtotals, percentages, and aggregations.
+Flatbread is a Python library that extends pandas with tabulation features. It makes it easy to create and display summary tables with totals, subtotals, percentages, and aggregations.
 
 Flatbread can be accessed in `DataFrames` and `Series` using the `pita` accessor.
 
+It uses the [wc-simple-table](https://github.com/lcvriend/wc-simple-table) dataviewer web component to display tables in a notebook: [check out some examples](https://lcvriend.github.io/wc-simple-table/).
+
 ## Key Features
 
 - Add row and column totals/subtotals to DataFrames and Series
 - Calculate and format percentages with proper rounding
-- Chain operations
 - Preserve data types and index structures
 - Table display in Jupyter notebooks
 
@@ -720,12 +718,12 @@ import flatbread
 
 df = pd.DataFrame(...)
 
-# Add totals and percentages in one chain
+# Add totals and percentages
 result = (
-    df.pita
-    .add_totals()           # Add grand totals
-    .add_subtotals(level=0) # Add subtotals by first index level
-    .add_percentages()      # Add percentage columns
+    df
+    .pita.add_totals()           # Add grand totals
+    .pita.add_subtotals(level=0) # Add subtotals by first index level
+    .pita.add_percentages()      # Add percentage columns
 )
 
 # Display with interactive viewer

flatbread-0.1.2/flatbread/config.py

@@ -0,0 +1,133 @@
+import functools
+import json
+from pathlib import Path
+from typing import Callable
+
+
+def deep_merge(base: dict, update: dict) -> dict:
+    """
+    Deep merge two dictionaries, preserving structure from both.
+
+    - When both dicts have a dict at the same key, merge recursively
+    - When update has keys not in base, add them
+    - When types mismatch (e.g., dict in one, value in other), prefer update
+
+    Parameters
+    ----------
+    base : dict
+        Base dictionary to merge into
+    update : dict
+        Dictionary with values to update base with
+
+    Returns
+    -------
+    dict
+        Merged dictionary
+    """
+    merged = base.copy()
+    for key, update_val in update.items():
+        if key not in merged:
+            # Add keys from update that don't exist in base
+            merged[key] = update_val
+        elif isinstance(update_val, dict) and isinstance(merged[key], dict):
+            # Recursively merge nested dictionaries
+            merged[key] = deep_merge(merged[key], update_val)
+        else:
+            # Override base value with update value
+            merged[key] = update_val
+    return merged
+
+
+def find_project_config(max_levels: int = 5) -> Path|None:
+    """
+    Find project-level .flatbread.json, traversing up from current directory.
+
+    Parameters
+    ----------
+    max_levels : int, default 5
+        Maximum number of directory levels to traverse upward
+
+    Returns
+    -------
+    Path or None
+        Path to the config file if found, None otherwise
+    """
+    current_dir = Path.cwd()
+    home_dir = Path.home()
+
+    # Check current directory and up to max_levels parent directories
+    for _ in range(max_levels + 1):
+        config_path = current_dir / ".flatbread.json"
+        if config_path.is_file():
+            return config_path
+
+        # Stop if we've reached the filesystem root or home directory
+        if current_dir == current_dir.parent or current_dir == home_dir:
+            break
+
+        # Move up one directory
+        current_dir = current_dir.parent
+
+    return None
+
+
+def read_config():
+    """
+    Read configuration with priority: project > user > defaults.
+
+    Returns
+    -------
+    dict
+        Merged configuration dictionary
+    """
+    # 1. Look for project config first
+    project_config = None
+    if project_path := find_project_config():
+        project_config = json.loads(project_path.read_text())
+
+    # 2. Look for user config
+    user_config = None
+    user_config_path = Path('~/.flatbread.json').expanduser()
+    if user_config_path.exists():
+        user_config = json.loads(user_config_path.read_text())
+
+    # 3. Get default config
+    package_path = Path(__file__).resolve().parent
+    config = json.loads((package_path / 'config/config.defaults.json').read_text())
+
+    # Merge configs with right precedence
+    if user_config:
+        config = deep_merge(config, user_config)
+    if project_config:
+        config = deep_merge(config, project_config)
+
+    return config
+
+
+def inject_defaults(defaults: dict) -> Callable:
+    """
+    Load defaults if keywords are None or undefined when calling a function.
+
+    Arguments
+    ---------
+    defaults (dict):
+        Dictionary of keywords and default values.
+
+    Return
+    ------
+    func:
+        Function that will load defaults.
+
+    Notes
+    -----
+    This decorator will override any default values set in the function definition.
+    """
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            for key, val in defaults.items():
+                if kwargs.get(key) is None:
+                    kwargs[key] = val
+            return func(*args, **kwargs)
+        return wrapper
+    return decorator

{flatbread-0.1.0 → flatbread-0.1.2}/flatbread/tooling.py

@@ -86,7 +86,7 @@ def sort_totals(
 @singledispatch
 def add_level(
     data,
-    item: Any,
+    values: Any|list[Any],
     level: int = 0,
     level_name: Any = None,
     axis: Axis = 0,
@@ -97,7 +97,7 @@ def add_level(
 @add_level.register
 def _(
     data: pd.DataFrame,
-    value: Any,
+    value: Any|list[Any],
     level: int = 0,
     level_name: Any = None,
     axis: Axis = 0,
@@ -109,8 +109,8 @@ def _(
     ----------
     data (pd.DataFrame):
         Input DataFrame.
-    value (Any):
-        Value to fill the new level with.
+    value Any|list[Any]
+        Either a single value to fill the entire level with, or a list of values with length matching the axis size. Values will be mapped in order.
     level (int, optional):
         Position to insert the new level. Defaults to 0 (start).
     level_name (Any, optional):
@@ -126,11 +126,25 @@ def _(
     data = data.copy()
     target = data.index if axis in [0, 'index'] else data.columns
 
+    if isinstance(value, list):
+        if len(value) != len(target):
+            raise ValueError(
+                f"Length of values list ({len(value)}) must match "
+                f"length of {'index' if axis in [0, 'index'] else 'columns'} ({len(target)})"
+            )
+
     if not isinstance(target, pd.MultiIndex):
         original_name = target.name
         target = pd.MultiIndex.from_arrays([target], names=[original_name])
 
-    new_keys = [add_value_to_key(key, value, level) for key in target]
+    new_keys = [
+        add_value_to_key(
+            key,
+            value[i] if isinstance(value, list) else value,
+            level
+        )
+        for i, key in enumerate(target)
+    ]
     new_names = add_value_to_key(target.names, level_name, level)
     new_index = pd.MultiIndex.from_tuples(new_keys, names=new_names)
 
@@ -156,8 +170,8 @@ def _(
     ----------
     data (pd.Series):
         Input Series.
-    value (Any):
-        Value to fill the new level with.
+    value Any|list[Any]
+        Either a single value to fill the entire level with, or a list of values with length matching the axis size. Values will be mapped in order.
     level (int, optional):
         Position to insert the new level. Defaults to 0 (start).
     level_name (Any, optional):
@@ -173,11 +187,25 @@ def _(
     data = data.copy()
     target = data.index
 
+    if isinstance(value, list):
+        if len(value) != len(target):
+            raise ValueError(
+                f"Length of values list ({len(value)}) must match "
+                f"length of index ({len(target)})"
+            )
+
     if not isinstance(target, pd.MultiIndex):
         original_name = target.name
         target = pd.MultiIndex.from_arrays([target], names=[original_name])
 
-    new_keys = [add_value_to_key(key, value, level) for key in target]
+    new_keys = [
+        add_value_to_key(
+            key,
+            value[i] if isinstance(value, list) else value,
+            level
+        )
+        for i, key in enumerate(target)
+    ]
     new_names = add_value_to_key(target.names, level_name, level)
     new_index = pd.MultiIndex.from_tuples(new_keys, names=new_names)
     data.index = new_index

{flatbread-0.1.0 → flatbread-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "flatbread"
-version = "0.1.0"
+version = "0.1.2"
 description = "Pandas extension for aggregation and tabular display"
 readme = "readme.md"
 requires-python = ">=3.10"

{flatbread-0.1.0 → flatbread-0.1.2}/readme.md

@@ -1,17 +1,15 @@
-Here's a concise README for flatbread:
-
-```markdown
 # Flatbread
 
-Flatbread is a Python library that extends pandas with tabulation features through a chainable API. It makes it easy to create summary tables with totals, subtotals, percentages, and aggregations.
+Flatbread is a Python library that extends pandas with tabulation features. It makes it easy to create and display summary tables with totals, subtotals, percentages, and aggregations.
 
 Flatbread can be accessed in `DataFrames` and `Series` using the `pita` accessor.
 
+It uses the [wc-simple-table](https://github.com/lcvriend/wc-simple-table) dataviewer web component to display tables in a notebook: [check out some examples](https://lcvriend.github.io/wc-simple-table/).
+
 ## Key Features
 
 - Add row and column totals/subtotals to DataFrames and Series
 - Calculate and format percentages with proper rounding
-- Chain operations
 - Preserve data types and index structures
 - Table display in Jupyter notebooks
 
@@ -23,12 +21,12 @@ import flatbread
 
 df = pd.DataFrame(...)
 
-# Add totals and percentages in one chain
+# Add totals and percentages
 result = (
-    df.pita
-    .add_totals()           # Add grand totals
-    .add_subtotals(level=0) # Add subtotals by first index level
-    .add_percentages()      # Add percentage columns
+    df
+    .pita.add_totals()           # Add grand totals
+    .pita.add_subtotals(level=0) # Add subtotals by first index level
+    .pita.add_percentages()      # Add percentage columns
 )
 
 # Display with interactive viewer

flatbread-0.1.0/flatbread/config.py

@@ -1,43 +0,0 @@
-import functools
-import json
-from pathlib import Path
-from typing import Callable
-
-
-def read_config():
-    config_path = Path('~/.flatbread/config.json').expanduser()
-    if not config_path.exists():
-        package_path = Path(__file__).resolve().parent
-        config_path = package_path / 'config/config.defaults.json'
-    json_string = config_path.read_text()
-    config = json.loads(json_string)
-    return config
-
-
-def inject_defaults(defaults: dict) -> Callable:
-    """
-    Load defaults if keywords are None or undefined when calling a function.
-
-    Arguments
-    ---------
-    defaults (dict):
-        Dictionary of keywords and default values.
-
-    Return
-    ------
-    func:
-        Function that will load defaults.
-
-    Notes
-    -----
-    This decorator will override any default values set in the function definition.
-    """
-    def decorator(func):
-        @functools.wraps(func)
-        def wrapper(*args, **kwargs):
-            for key, val in defaults.items():
-                if kwargs.get(key) is None:
-                    kwargs[key] = val
-            return func(*args, **kwargs)
-        return wrapper
-    return decorator