Skip to content

Change Log

v1.6.0

v1.6.0 - Standardise Type Safety, Simplify Overloads, and Enhance Documentation🔗

🏷v1.6.0
📆2026-01-02
🔗data-science-extensions/toolbox-python/releases/v1.6.0

Release Notes

📋 Summary🔗

Standardise the type hinting system across the entire library, transitioning from custom type aliases to native Python typing constructs. Simplify complex function overloads in the checkers.py and output.py modules, improve the robustness of type checking logic, and expand the documentation for core utility classes.

🛡️ Type Safety & Standardisation🔗

  • Native Typing: Replace custom type aliases like any_collection, str_collection, and scalar with standard library types such as Collection[Any], Collection[str], and Any.
  • Explicit Callables: Add explicit Callable[..., bool] and Callable[..., None] type annotations to function aliases in the checkers.py module for improved static analysis.
  • Generic Collections: Refactor internal logic to use Collection[type] instead of specific list or tuple types, allowing for more flexible input handling.
  • List Standardisation: Update all __all__ export lists and internal string lists to use the native list[str] type.

⚙️ Logic & Overload Simplification🔗

  • Overload Consolidation: Reduce the number of @overload definitions for is_all_values_of_type(), assert_value_of_type(), and list_columns() by using more general collection types.
  • Robust Type Checking: Improve the is_value_of_type() function to correctly handle non-type iterables by using a more direct not isinstance(check_type, type) check.
  • Constant Relocation: Move the log_levels Literal from collection_types.py to output.py to better align with its primary usage in logging utilities.
  • Flattening Logic: Refine the flatten() function to use Collection[Collection[Any]] for input parameters, removing the need for internal type ignores.

📖 Documentation & DX🔗

  • Class Methods Documentation: Update the Defaults() class docstring to include a dedicated "Methods" section, documenting the .get(), ._validate_value_and_default(), and ._validate_type() methods.
  • Docstring Accuracy: Refactor parameter descriptions across multiple modules to reflect the shift from "tuple of types" to "Sequence of types" or "Collection of types".
  • Retry Metadata: Add descriptive docstrings for internal type aliases and generic type variables in the retry.py module.

🛠️ Bug Fixes & Refinements🔗

  • Attribute Errors: Fix a missing .__name__ attribute access in error message generation for type assertions.
  • Typo Remediation: Correct several typos in docstrings and internal variable names across the checkers.py and bools.py modules.
  • Dictionary Reversal: Update dict_reverse_keys_and_values() to return explicit dict[str, Any] types, ensuring better compatibility with downstream consumers.

💪 What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.5.0...v1.6.0

Updates
  • d7d73f1: Fix typo (by chrimaho)
  • 512d560: Fix missing .__name__ attribute
    When accessing and formatting the type in the error message. This line should be msg += f"Must be '{check_type.__name__}'" to be consistent with line 647 in assert_value_of_type() and to produce cleaner error messages that show just the type name (e.g., 'int') rather than the full type object representation (e.g., <class 'int'>). (by chrimaho)
  • 81b4053: Fix typo (by chrimaho)
  • 469fc66: Fix typo (by chrimaho)
  • d487a03: Fix typo (by chrimaho)
  • 7eb6a37: Fix typo (by chrimaho)
  • 0d523a9: Standardise type hints and simplify overloads
    • Replace custom type aliases from the toolbox_python.collection_types module with standard library types like list[str], Collection[Any], and Dict[Any, Any].
    • Simplify is_value_of_type() and assert_value_of_type() function overloads by using Collection[type] to handle multiple input sequences.
    • Relocate the log_levels type literal to output.py module to better align with its usage in output formatting.
    • Add explicit Callable type hints to function aliases within the checkers.py module for improved type clarity.
    • Update the Defaults() class docstring to include a dedicated methods section documenting the .get() method.
    • Refactor the flatten() function and the list_columns() function to use standard collection types and remove redundant @overload definitions.
    • Improve type checking logic in the checkers.py module to handle generic collections of types more robustly. (by chrimaho)

v1.5.0

v1.5.0 - Modernise Infrastructure, Refactor Core Logic, and Introduce Numeric Validation🔗

🏷v1.5.0
📆2025-12-28
🔗data-science-extensions/toolbox-python/releases/v1.5.0

Release Notes

📋 Summary🔗

Modernise the development infrastructure, refactor core logic for better maintainability, and expand the utility suite with new validation capabilities. Transition the project to uv for package management, introduce code complexity analysis, and refactor the retry() decorator into a robust class-based implementation.

🚀 Infrastructure Modernisation🔗

  • Package Management: Standardise on uv for all package management, environment synchronisation, and script execution tasks.
  • Dependency Consolidation: Remove the requirements/ directory and Makefile in preference for a unified pyproject.toml configuration.
  • Python 3.14 Support: Update CI/CD workflows to include Python 3.14 in the test matrix, ensuring forward compatibility.
  • Windows Compatibility: Fix UnicodeEncodeError in CI by forcing UTF-8 encoding for log output on Windows runners.

🛠️ Core Refactoring & Quality🔗

  • Retry Logic: Refactor the retry() decorator into a helper _Retry() class, reducing cyclomatic complexity from 17 to 4 and improving modularity.
  • Metadata Management: Replace hardcoded version strings with dynamic retrieval via the metadata() function, simplifying the release process.
  • Type Checking: Replace mypy with ty for faster and more consistent type checking across the codebase.
  • Complexity Analysis: Integrate complexipy to automate code complexity monitoring and enforce maintainability standards.

🧪 New Validation Utilities🔗

  • Validators() Class: Introduce the Validators() class to centralise logic for numeric range validation.
  • Range Checks: Implement .value_is_between() and .all_values_are_between() methods for flexible boundary checking.
  • Assertion Support: Provide .assert_value_is_between() and .assert_all_values_are_between() methods to raise descriptive AssertionError() class exceptions.

📖 Documentation & DX🔗

  • README Overhaul: Update README.md with modernised setup guides, uv workflows, and expanded quality assurance documentation.
  • Docstring Standardisation: Migrate docstring formatting checks to a pre-commit hook using docstring-format-checker.
  • Utility Scripts: Refactor src/utils/scripts.py to use dynamic package constants and improve subprocess handling.

🔍 Technical Improvements🔗

  • Type Hint Enhancements: Standardise type annotations using Optional, Union, and Literal for better compatibility and clarity.
  • Pylint Remediation: Resolve numerous Pylint warnings and suppress specific flags where appropriate to maintain a 10/10 quality score.
  • Exception Handling: Standardise exception storage and update return type hints (e.g., NoReturn) for better static analysis.

💪 What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.4.1...v1.5.0

Updates
  • 4b24e77: Add explicit return to print_or_log_output()
    • Optimise function readability and ensure explicit return behaviour for the print_or_log_output() function. (by chrimaho)
  • 57c8f79: Expose methods in the Validators() class
    • Expose the .value_is_between() method, .assert_value_is_between() method, .all_values_are_between() method, and .assert_all_values_are_between() method to make them public.
    • Add a class-level docstring to the Validators() class to summarise its purpose and available methods.
    • Update unit tests and internal method calls to reference the renamed public methods. (by chrimaho)
  • 4b98b35: Fix typo in environment variable name (by chrimaho)
  • aad6e43: Simplify directory removal flags
    • Use -r instead of --recursive in check_build() and check_mkdocs() functions
    • Standardise directory removal commands for consistency
    • Ensure commands can be run on all OS's consistently (by chrimaho)
  • 0511c0e: Update CI workflow to run checks with specific script (by chrimaho)
  • 9a8bc46: Delete requirements/ directory in preference for pyproject.toml config (by chrimaho)
  • 152e120: Update README to include package changes
    • Add uv as a supported installation method to improve package management efficiency
    • Replace legacy pipenv and poetry setup guides with uv sync workflows to simplify environment builds
    • Standardise development scripts using the uv run src/utils/scripts.py script for unified task execution
    • Expand quality assurance requirements to include complexity and docstring checks for better code maintainability
    • Update reference links to include uv, ty, complexipy, and dfc and fix the documentation URL (by chrimaho)
  • 3718726: Refactor CI workflow with updated actions and env var
    Updated CI workflow to use newer action versions and added PACKAGE_NAME environment variable. (by chrimaho)
  • d7ef4f6: Refactor CI/CD and add support Python for 3.14
    • Include Python 3.14 in test matrices to ensure forward compatibility.
    • Remove redundant debug jobs to reduce workflow clutter and execution time.
    • Standardise script execution by invoking utility scripts directly via uv run.
    • Force package reinstallation and upgrades using the --reinstall-package and --upgrade flags in the uv sync command.
    • Set PYTHONIOENCODING to utf-8 to ensure consistent log output.
    • Increase max-parallel to 30 to speed up multi-platform installation checks.
    • Extend artifact retention to 5 days for better post-build access.
    • Refine the uv publish command to use explicit token flags and disable caching. (by chrimaho)
  • 50efdd9: Refactor git utilities and subprocess handling
    • Add encoding="utf-8" to the run() function call within the run_command() function to standardise text handling
    • Extract branch checkout logic into a new git_checkout_branch() function to deduplicate git_switch_to_main_branch() and git_switch_to_docs_branch() functions
    • Introduce git_switch_to_branch() function to support branch switching via command-line arguments
    • Optimise git_add_coverage_report() function by ensuring the destination directory exists before copying files
    • Simplify add_git_credentials() and git_fix_tag_reference() functions by removing redundant comments and streamlining command execution (by chrimaho)
  • 5999a79: Remove redundant metadata attributes
    • Remove __license__, __url__, and __description__ variables
    • Organise the package root by removing secondary metadata attributes (by chrimaho)
  • bb46a37: Standardise exception storage and update type hints
    • Standardise the exceptions attribute in the _Retry() class by ensuring it always stores a tuple of exception types.
    • Update the ._handle_final_failure() method to use the NoReturn type hint as it consistently raises a RuntimeError() class. (by chrimaho)
  • 2abcd3b: Refactor retry logic into a helper class
    • Extract the core logic from the retry() decorator into a new internal _Retry() class to improve maintainability.
    • Modularise error handling by introducing specific methods like ._handle_expected_error() and ._handle_unexpected_error() within the _Retry() class.
    • Update the retry() decorator to instantiate the _Retry() class and invoke its .run() method.
    • Strengthen type hinting by incorporating Any and defining explicit return types for the internal wrapper.
    • Reduce module complexity from >17 to ~4 (by chrimaho)
  • 857900f: Fix misaligned parameter docs and function signatures (by chrimaho)
  • 14781b7: Update print_or_log_output() function typing
    • Add a new @overload for the print_or_log_output() function to support Optional parameters.
    • Update the print_or_log_output() function signature to accept an Optional value for the print_or_log argument.
    • Standardise the log_level type hint within the docstring of the print_or_log_output() function.
    • Reformat existing @overload declarations for the print_or_log_output() function to improve readability.
    • Add an assert to ensure that the print_or_log parameter is never None (by chrimaho)
  • 2e057dd: Remove redundant Makefile (by chrimaho)
  • e1d1240: Standardise package metadata and versioning
    • Replace hardcoded version strings with dynamic retrieval via the metadata() function
    • Remove the custom bump_version.py utility and its configuration in the pyproject.toml file
    • Update the CD workflow to use the native uv version command
    • Delete the test_version.py file as hardcoded version checks are no longer necessary
    • Expand the __init__.py file to dynamically expose package metadata such as version and author (by chrimaho)
  • 9ececa7: Remove Python version upper bound
    • Update requires-python to remove the <4.0 restriction
    • Standardise the configuration to improve forward compatibility (by chrimaho)
  • 48da0dd: Fix formatting (by chrimaho)
  • 3ea392b: Fix tuple type hint for nested parameters
    • Update the tuple() class type hint within the name_func_nested_list() function to include an ellipsis for variable-length support. (by chrimaho)
  • 1eeacc8: In the lists module, fix types in docstrings to match the function signatures (by chrimaho)
  • 02acdeb: Fix docsting error in the dictionaries module
    • Related to the use of * in the Params section (by chrimaho)
  • 9bb4c8b: Add missing typehints to the functions and methods in the dictionaries module (by chrimaho)
  • f2d9152: Add new validators utility
    • Introduce Validators() class to centralise logic for checking if numeric values fall within specified bounds
    • Implement ._value_is_between() method to perform individual range checks and validate that boundary arguments are logical
    • Provide ._assert_value_is_between() method to raise an AssertionError when a value violates the defined range
    • Include ._all_values_are_between() method and ._assert_all_values_are_between() method to facilitate bulk validation of sequences
    • Add unit tests to verify correct behaviour and error handling for the new Validators() class (by chrimaho)
  • 4415ef4: Standardise type hints and improve type checks
    • Update type annotations to use the Optional() and Union() classes for better compatibility within the Defaults() class.
    • Replace the is_type() function call with the standard isinstance() function within the .get() method to verify string values.
    • Standardise method signatures for the ._validate_value_and_default() and ._validate_type() methods to use explicit typing constructs. (by chrimaho)
  • 43c039d: Update check_type variadic tuple hints
    • Correct the tuple type hint to include the ellipsis ... to properly represent variadic tuples in the docstrings.
    • Ensure the check_type parameter documentation accurately reflects that multiple types can be provided.
    • Standardise the docstrings for the is_value_of_type(), is_all_values_of_type(), is_any_values_of_type(), assert_value_of_type(), assert_all_values_of_type(), and assert_any_values_of_type() functions. (by chrimaho)
  • b51e693: Fix missing complexipy dependency (by chrimaho)
  • af5d00c: Reorder checks and add complexity validation
    • Move check_pylint() function after check_pycln() function to improve linting workflow
    • Add check_complexity() function to the check() function sequence to monitor code quality
    • Prioritise check_pytest() function execution by moving it before documentation and build checks (by chrimaho)
  • 1781bf0: Refactor and generalise check_docstrings()
    • Relocate the check_docstrings() function to improve logical file structure
    • Update the check_docstrings() function to reference the DIRECTORY_NAME constant
    • Standardise the source path within the check_docstrings() function to support dynamic directory names (by chrimaho)
  • 6dcf1cd: Update utility scripts to use dynamic package name constants.
    • Define PACKAGE_NAME and DIRECTORY_NAME constants to centralise configuration
    • Update check_pylint() function to use the dynamic DIRECTORY_NAME constant
    • Refine check_pycln() function to target the specific package directory (by chrimaho)
  • 008cdf5: Update pre-commit hook exclusions
    • Expand the exclusion pattern in .pre-commit-config.yaml to include the src/utils/ and src/tests directories.
    • Utilise a multi-line regex format to manage multiple excluded paths more effectively. (by chrimaho)
  • b0da3dd: Add complexipy for code complexity analysis
    • Define the check_complexity() function to automate quality checks and analyse code complexity levels to guide developers
    • Configure the [tool.complexipy] section to establish analysis parameters that enforce coding standards
    • Set the max-complexity-allowed parameter to 15 to ensure code remains maintainable (by chrimaho)
  • 167398f: Eliminate redundant scripts from the pyproject.toml file, prefer the src/utils/scripts.py module (by chrimaho)
  • 0609a01: Clean up outdated checks in the pre-commit config file (by chrimaho)
  • baf5032: Replace mypy with ty for type checking
    • Replace mypy with ty in the test dependency group to standardise type checking
    • Remove the [tool.mypy] configuration block
    • Rename the check_mypy() function to the check_ty() function
    • Update the check_ty() function to execute the ty check command using a dynamic directory path
    • Update the check() function to call the check_ty() function (by chrimaho)
  • 1fb978e: Refactor type annotations and improve commit formatting
    • Replace union type syntax with Optional and Literal imports for better compatibility
    • Enhance commit message processing to filter out co-authored-by lines and empty lines
    • Update commit output format to include short SHA with link and improved author attribution
    • Fix release title reference to use name property instead of deprecated title
    • Add type ignore comment for repository retrieval to suppress type checker warnings
    • Include main execution guard for proper script entry point handling (by chrimaho)
  • b408c39: Migrate docstring format checker to pre-commit hook
    • Replace local docstring checking implementation with external pre-commit repository
    • Use docstring-format-checker from data-science-extensions organisation at version 1.3.0
    • Maintain same configuration and output format whilst leveraging standardised tooling
    • Comment out previous local implementation to preserve configuration for reference (by chrimaho)
  • ff3dba7: Standardise GitHub Actions workflow configuration
    • Consolidate permissions at workflow level instead of per-job for better maintainability
    • Update all action versions to latest stable releases for improved security and features
    • Replace hardcoded values with environment variables for better configurability
    • Enable PyPI package publishing by uncommenting the publish step
    • Improve package installation verification with explicit version constraints
    • Reorganise job execution order by moving tag reference fix after package upload
    • Add python-version-file configuration for consistent Python version management
    • Correct CI job matrix to run on specified operating systems instead of ubuntu-latest only
    • Enhance environment variable coverage for tokens, repository details, and build settings (by chrimaho)
  • e4e7676: Comment out project scripts in pyproject.toml
    • Temporarily disable all console script entry points to prevent command-line tool conflicts
    • Preserve script definitions for future re-enablement by commenting rather than removing
    • Affects syncing, linting, checking, git operations, and documentation scripts
    • Maintains project configuration structure whilst removing executable commands (by chrimaho)
  • 5107d2d: Refactor docstring validation and fix CLI argument handling
    • Replace custom docstring validation logic with external dfc tool for improved consistency and maintainability
    • Remove unused imports including ast, re, math.e, and various typing components
    • Fix CLI argument indexing from sys.argv[1] to sys.argv[2] across multiple functions to account for function name parameter
    • Remove complex FunctionAndClassDetails class and associated validation methods
    • Simplify check_docstrings() function to use single dfc --output=table ./src/toolbox_python command
    • Add centralised CLI execution logic with function name resolution and error handling
    • Eliminate over 290 lines of custom docstring parsing and validation code (by chrimaho)
  • fa4ec29: Add docstring-format-checker to docs dependencies and tidy up all docstrings
    • Details admonition: ???+ info "Details" --> ???+ abstract "Details"
    • Notes admonition: ???+ info "Notes" --> ???+ abstract "Notes"
    • Generic type list: Type --> (Type)
    • Typos: Parameters --> Params
    • Missing docstrings (by chrimaho)
  • 713ae0e: Run linting for better formatting (by chrimaho)
  • 5f32f50: Enhance type checking in checkers.py and output.py by adding more comprehensive @overload conditions for better clarity and functionality. (by chrimaho)
  • 2de8701: Remove redundant lines (by chrimaho)
  • 1d9acdd: Fix missing type hints (by chrimaho)

v1.4.1

v1.4.1 - Documentation Infrastructure Enhancement and Automated Changelog Generation🔗

🏷v1.4.1
📆2025-08-03
🔗data-science-extensions/toolbox-python/releases/v1.4.1

Release Notes

📋 Summary🔗

Version 1.4.1 focuses on enhancing the project's documentation infrastructure and establishing automated changelog generation capabilities. This release introduces comprehensive contribution guidelines, automated changelog workflows, and improved documentation styling to streamline the development process and enhance the contributor experience.

🔄 Automated Changelog System🔗

  • CI/CD Integration: Automated changelog generation integrated into the continuous deployment pipeline using GitHub Actions
  • Environment Variables: Added support for GITHUB_TOKEN and REPOSITORY_NAME environment variables for secure API access
  • CLI Command: Introduced generate-changelog command for manual changelog creation and debugging purposes
  • Version Control: Automatic commit of changelog updates with version-specific commit messages and skip CI flags

📚 Contribution Framework🔗

  • Guidelines Documentation: Created comprehensive CONTRIBUTING.md with detailed procedures for issue reporting, branch management, coding standards, and review processes
  • Documentation Integration: Added contribution guidelines to the documentation site at docs/usage/contributing.md for improved discoverability
  • Developer Onboarding: Established clear expectations and workflows to reduce contributor onboarding time

📁 Documentation Site Enhancements🔗

🎨 Visual Improvements🔗

  • Custom Styling: Implemented shortcode CSS system with badge support for enhanced visual consistency across documentation
  • Navigation Structure: Improved site navigation with better organisation and user experience
  • MkDocs Configuration: Enhanced site configuration with updated plugin management and table of contents depth limiting

📖 Content Organisation🔗

  • Changelog Integration: Added dedicated changelog page (docs/usage/changelog.md) within the documentation site
  • Reference Architecture: Established standardised documentation structure for consistency across all pages

🧐 Technical Implementation🔗

🔧 Workflow Automation🔗

  • Release Process: Enhanced cd.yml workflow with automated changelog generation steps
  • Error Handling: Improved workflow reliability with proper dependency management and error handling
  • Version Management: Automated tracking and updating of version information throughout the release process

📦 Package Configuration🔗

  • CLI Scripts: Updated pyproject.toml with new CLI commands for changelog generation
  • Build System: Maintained compatibility with existing build processes whilst adding new automation capabilities

🔍 Code Quality & Infrastructure🔗

🧪 Maintenance Scripts🔗

  • Changelog Utilities: Enhanced src/utils/changelog.py with improved formatting, error handling, and environment variable support
  • Release Automation: Streamlined release note generation with better readability and maintainability
  • Git Integration: Improved git history processing for structured changelog creation

📊 Documentation Standards🔗

  • Formatting Consistency: Standardised formatting across all documentation files for improved readability
  • Content Structure: Established clear patterns for documentation organisation and presentation

📈 Developer Experience Improvements🔗

🤝 Contributor Benefits🔗

  • Clear Guidelines: Comprehensive contribution documentation reduces confusion and speeds up onboarding
  • Automated Workflows: Changelog generation eliminates manual documentation overhead for maintainers
  • Consistent Standards: Established coding and documentation standards improve code quality and review efficiency

🔧 Maintainer Benefits🔗

  • Reduced Manual Work: Automated changelog generation significantly reduces maintenance overhead
  • Quality Assurance: Clear contribution guidelines ensure consistent quality across contributions
  • Streamlined Processes: Automated workflows improve release reliability and reduce human error

🏗️ Infrastructure Foundation🔗

This release establishes a robust foundation for project documentation and automation. The automated changelog system ensures accurate version history tracking, whilst the comprehensive contribution guidelines provide clear expectations for all project participants.

The enhanced documentation infrastructure supports better collaboration and reduces the barrier to entry for new contributors, fostering a more inclusive and efficient development environment.

💪 What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.4.0...v1.4.1

Updates

v1.4.0

v1.4.0 - Comprehensive Package Enhancement and Tooling Migration🔗

🏷v1.4.0
📆2025-07-13
🔗data-science-extensions/toolbox-python/releases/v1.4.0

Release Notes

📋 Overview🔗

This release introduces significant enhancements to the toolbox-python package, including a new generators module, expanded validation capabilities, comprehensive docstring standards, and modernized CI/CD workflows. The changes span 30 commits across multiple areas of the codebase to improve functionality, maintainability, and developer experience while maintaining full backward compatibility.

🆕 New Modules and Core Functionality🔗

Generators Module🔗

  • New module: toolbox_python.generators - Provides functions for computing data on-the-fly based on input parameters rather than storing it in databases or files
  • New function: generate_group_cutoffs() - Divides a total number of items into specified groups, returning start and end indices for each group with proper validation and error handling
  • Documentation: Added comprehensive documentation with examples and complete test coverage

Enhanced Checkers Module🔗

  • New constant: OPERATORS dictionary - Defines comparison operations for value validation including <, <=, >, >=, ==, !=, in, and not in
  • New function: is_valid_value() - Checks if a value is valid based on a specified operator and target value
  • New function: assert_is_valid_value() - Assert version of the validation function with proper error handling
  • Enhanced aliases: Added is_valid and assert_is_valid function aliases for consistency and convenience

Enhanced Strings Module🔗

  • New function: str_to_list() - Converts strings to single-element lists while preserving other data types unchanged
  • Type safety: Includes comprehensive overloads and type hints for better development experience
  • Input flexibility: Provides a convenient way to normalize string inputs for functions that expect list-like objects

🔧 Function Enhancements and Type Safety🔗

Improved Type Hints and Overloads🔗

  • Enhanced overloads: Added @overload decorators for better type hints in:
  • toolbox_python.checkers.is_value_of_type() - Now properly handles both single types and tuple of types
  • toolbox_python.output.list_columns() - Distinguishes between print and return modes
  • toolbox_python.retry.retry() - Better handling of different parameter combinations
  • Type validation: Enhanced parameter validation across multiple functions using new assertion functions

Function Robustness Improvements🔗

  • Parameter validation: Added comprehensive input validation using assert_is_valid functions to ensure type safety and value constraints
  • Error handling: Improved exception handling for the retry() function with better logging initialization and normalized exception parameter handling
  • Code structure: Better organization with descriptive comments separating validation, preparation, processing, and output phases
  • Column width logic: Simplified logic in list_columns() by replacing conditional assignment with min() function for cleaner code

📜 Package Scripts and Automation🔗

Comprehensive Utility Scripts🔗

  • Script module: src/utils/scripts.py - Extensive collection of utility functions organized into categories:
  • Syncing: uv_sync() for dependency management
  • Linting: run_black(), run_isort(), run_pycln(), run_pyupgrade(), run_blacken_docs(), and combined lint()
  • Checking: check_black(), check_mypy(), check_pytest(), check_codespell(), check_pylint(), and comprehensive check()
  • Git operations: add_git_credentials(), git_refresh_current_branch(), git_switch_to_main_branch(), git_add_coverage_report()
  • Documentation: docs_build_static(), docs_serve_versioned(), build_versioned_docs(), and version management

Project Scripts Configuration🔗

  • Package scripts: Added extensive [project.scripts] table in pyproject.toml with organized sections:
  • Syncing: sync
  • Linting: run-black, run-isort, lint, lint-check
  • Checking: check-black, check-mypy, check-pytest, check-docstrings, check
  • Git: add-git-credentials, git-switch-to-main-branch, bump-version, git-update-version
  • Docs: docs-serve-static, build-versioned-docs, docs-check-versions
  • Enhanced version management: Updated src/utils/bump_version.py for better CLI compatibility and version tracking

📚 Docstring Standards and Validation🔗

Automated Docstring Validation System🔗

  • Validation infrastructure: Implemented comprehensive docstring checking with strict formatting requirements:
  • FunctionAndClassDetails() - Named tuple for tracking function and class details
  • check_docstrings_file() - Validates docstrings in individual files with detailed error reporting
  • _check_single_docstring() - Validates individual function/class docstrings against standards
  • _check_section_order() - Ensures proper section ordering (Summary → Params → Returns/Yields → Examples)
  • _validate_section_formats() - Validates specific section formats and content structure
  • check_docstrings_cli(), check_docstrings_all(), check_docstrings_dir() - Various checking interfaces

Enhanced Docstring Standards🔗

  • Mandatory sections: Summary, Params, Returns/Yields, and Examples sections now required for all functions and classes
  • Format consistency: Fixed typos across all docstrings from !!! summary "Summary" to !!! note "Summary"
  • Examples improvements: Updated all code examples to use pycon syntax for better clarity and consistency
  • Type information: Enhanced Raises statements with proper exception types (e.g., TypeError, ValueError, LookupError) and detailed descriptions
  • Documentation quality: Improved parameter descriptions, return value specifications, and comprehensive usage examples

🚀 CI/CD Workflow Modernization🔗

Migration to UV-Based Tooling🔗

  • CI workflow: Complete refactoring of .github/workflows/ci.yml:
  • Replaced all make commands with uv run commands for improved consistency and performance
  • Added UV environment variables for optimal configuration
  • Streamlined dependency installation and checking processes
  • CD workflow: Comprehensive modernization of .github/workflows/cd.yml:
  • Replaced make commands with uv run commands throughout all jobs
  • Added environment variables for UV configuration (UV_LINK_MODE, UV_NATIVE_TLS, UV_NO_SYNC)
  • Improved git operations with new utility functions
  • Enhanced version management and tag handling
  • Fixed tag reference issues to ensure correct version numbers in releases
  • Streamlined package building and publishing processes

Enhanced Pre-commit Integration🔗

  • Hook updates: Updated pre-commit hook versions for better compatibility:
  • Updated mypy from v1.15.0 to v1.16.1 with additional --allow-redefinition flag
  • Updated pyupgrade from v3.19.1 to v3.20.0
  • Updated uv-pre-commit from 0.6.12 to 0.7.20
  • Removed outdated poetry check hooks
  • New validation: Added check-docstrings hook for continuous validation during development workflow

⚙️ Configuration and Build System Updates🔗

Project Configuration Enhancements🔗

  • Build system: Migrated from hatchling to uv_build for better integration with UV toolchain and improved build reliability
  • MyPy configuration: Updated to include no-redef in disable_error_code list for better type checking compatibility
  • Dependencies: Added uv to the development dependency group for comprehensive toolchain integration
  • Python requirements: Updated syntax from ">3.9,<4.0" to ">=3.9,<4.0" for standard compliance

Documentation Configuration🔗

  • MkDocs updates:
  • Added new generators module to navigation structure for complete module coverage
  • Fixed repository icon from material/gitlab to material/github for accurate branding
  • Enhanced navigation structure to reflect all available modules
  • Improved organization: Better categorization and presentation of module documentation

Enhanced Type System🔗

  • Collection types: Expanded collection_types.py with new type aliases:
  • Added datetime collections: datetime_list, datetime_tuple, datetime_set, datetime_list_tuple
  • Added int collections: int_set, int_list_tuple
  • Enhanced dict collections: reorganized and added better documentation
  • Improved organization with clear section comments for better maintainability

🧪 Testing and Quality Assurance🔗

Comprehensive Test Coverage🔗

  • New test modules: Added extensive test coverage for new functionality:
  • src/tests/test_generators.py - Complete test suite for the generators module with edge cases
  • Enhanced src/tests/test_strings.py - Tests for new str_to_list() function with various input types
  • Expanded src/tests/test_checkers.py - Comprehensive tests for new validation functions including OPERATORS testing
  • Test improvements: Updated existing tests to use pytest.raises instead of pytest imports for better compatibility
  • Coverage maintenance: Maintained 100% test coverage across all modules while adding new functionality

Quality Improvements🔗

  • Validation robustness: Enhanced function robustness through comprehensive parameter validation using new assertion functions
  • Error handling: Improved error capture and reporting in docstring checking with detailed feedback
  • Type safety: Better type hints and validation across the codebase with overloads and proper type checking
  • Code organization: Improved code structure with better separation of concerns and descriptive comments

🎯 Impact and Benefits🔗

This release significantly enhances the toolbox-python package by:

  • Expanding core functionality with new modules and utilities that provide valuable data processing capabilities for on-demand computation
  • Improving developer experience through better type hints, comprehensive validation, standardized tooling, and automated quality checks
  • Enhancing code quality with comprehensive validation systems, consistent documentation standards, and robust error handling
  • Modernizing CI/CD with migration to UV-based tooling for better reliability, performance, and maintainability
  • Strengthening maintainability through comprehensive testing, automated docstring validation, and organized project scripts
  • Improving type safety with enhanced type hints, validation functions, and comprehensive overloads for better IDE support

💪 Pull Requests🔗

The changes maintain full backward compatibility while providing substantial improvements to functionality, developer experience, and project maintenance workflows. All existing APIs remain unchanged, ensuring seamless upgrades for existing users.

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.3.1...v1.4.0

Updates
  • d333489: Fix echo command to use -E flag for proper interpretation of escape sequences (by chrimaho)
  • f110624: Temporarily turn off pypi deployment step (by chrimaho)
  • 0ea16ed: Refactor versioning commands to accept version as an argument and update related CLI functions (by chrimaho)
  • 5dd4c2f: Fix bug in the CD debugging job
    In the CD workflow, when it will throw an error for the github.event.release.name and github.event.release.body when they contain code which is surrounded by the back-tick: <br> This is because theecho` will escape the back-tick and try to execute the inner text as a command.
    This is undesirable behaviour. (by chrimaho)
  • 9520086: Fix version bump command and improve regex pattern matching to ensure correct and accurate execution (by chrimaho)
  • 8a4ffb7: Refactor git command executions to improve reliability, expandability and readability (by chrimaho)
  • e4de102: Fix bug in the scripts.git_add_coverage_report() function (by chrimaho)
  • fa1f050: Fix typo in generators module (by chrimaho)
  • d4f4e06: Fix typo in retry module (by chrimaho)
  • d4ae239: Refactor test files to replace any import pytest with from pytest import ... for improved consistency (by chrimaho)
  • 4987831: Add input validation for retry parameters using assert_is_valid (by chrimaho)
  • 22b3942: Refactor CD workflow to replace all 'make' commands with 'uv run' commands for improved consistency and performance (by chrimaho)
  • 48c7d1e: Reorganise the [project.scripts] table
    • Change from cli.scripts:... to utils:scripts:...
    • Reorder in to sections: Syncing, Linting, Checking
    • Add new sections: Git, Docs (by chrimaho)
  • 8d55c79: Move scripts.py fromsrc/cli to src/utils and add functions to handle git and docs processes (by chrimaho)
  • f6ad6de: Update bump_version util to be better compatable with CLI execution (by chrimaho)
  • 6ec8292: Add git_checks.sh script to capture git logs and diffs (by chrimaho)
  • 7673113: Refactor CI and CD workflows to replace 'make' commands with 'uv' commands for installations and checks (by chrimaho)
  • 251e4d0: Add a more robust way of capturing errors when checking docstrings (by chrimaho)
  • de2729a: Fix typos in all docstrings
    -> From !!! summary "Summary"
    -> To !!! note "Summary" (by chrimaho)
  • 44c6b07: Add functions to check docstrings in all Python files and in a specific directory (by chrimaho)
  • b60a092: Refactor command execution to support space expansion and simplify command syntax (by chrimaho)
  • 2fb403d: Fix typo (by chrimaho)
  • 86d0332: Add project scripts and update build system dependencies (by chrimaho)
  • 6c6c265: Add comprehensive docstring validation system
    • Implements automated docstring checking with strict formatting requirements including mandatory Summary, Params, Returns/Yields, and Examples sections.
    • Add custom pre-commit hook integration for continuous validation during development workflow.
    • Update existing docstrings to comply with new validation standards and fixes inconsistent section formatting across multiple modules. (by chrimaho)
  • e8a9e6f: Fix error with repo icon in docs page (by chrimaho)
  • 8c35b50: Fix typo (by chrimaho)
  • f789f2f: Improve checkers module documentation and formatting (by chrimaho)
  • 3bee8e3: Add new generators module for on-demand data generation
    • Introduces a new generators module that provides functions for computing data on-the-fly based on input parameters rather than storing it in databases or files.
    • Includes new generate_group_cutoffs() function that divides a total number of items into specified groups, returning start and end indices for each group with proper validation and error handling.
    • Updates documentation to include the new module in the main index with comprehensive description and examples. (by chrimaho)
  • a8e99cb: Refactors exception handling for the retry() function and add logging initialization
    • Normalizes exceptions parameter to always be a tuple for consistent handling regardless of input type.
    • Moves log variable initialization outside conditional block to improve code clarity and ensure proper variable scope. (by chrimaho)
  • 1169733: Add validation to the list_columns() function and improve code structure with better comments
    • Enhances function robustness by adding comprehensive parameter validation using assertion functions to ensure type safety and value constraints.
    • Improves code readability through better organization with descriptive comments that clearly separate validation, preparation, processing, and output phases.
    • Simplifies column width logic by replacing conditional assignment with min() function for cleaner code. (by chrimaho)
  • b730c3b: Add new str_to_list() function with overloads and corresponding tests
    • Introduces a new utility function that converts strings to single-element lists while preserving other data types unchanged.
    • This enhancement provides a convenient way to normalize string inputs for functions that expect list-like objects, improving code flexibility when handling mixed input types.
    • Includes comprehensive test coverage with parameterized tests for various input scenarios including strings, lists, tuples, sets, dictionaries, and numeric types. (by chrimaho)
  • 58653a3: Add additional @overload's for list_columns and retry functions to better enhance type hints in the output and retry modules (by chrimaho)
  • d4d0b98: Update pre-commit hooks versions and remove outdated poetry check (by chrimaho)
  • a4b4a15: Update all code docstrings examples to use pycon syntax for better clarity, and refine the Raises statements (by chrimaho)
  • 9eef933: Significant improvements to the checkers module
    • Added OPERATORS constant dictionary to define comparison operations.
    • Introduced is_valid_value and assert_is_valid_value functions for value validation based on operators.
    • Updated documentation in checkers.md to include new functions and constants.
    • Enhanced test coverage in test_checkers.py for the new validation functions.
    • Improved docstrings across all functions (by chrimaho)

v1.3.2

v1.3.2 - Update package config🔗

🏷v1.3.2
📆2025-05-25
🔗data-science-extensions/toolbox-python/releases/v1.3.2

Release Notes

This release updates the pyproject.toml file to enhance metadata clarity and correct the Python version requirement syntax. The most important changes include reorganizing and expanding the classifiers section and adjusting the requires-python field.

What's Changed🔗

Metadata improvements:🔗

  • Reorganized and expanded the classifiers section to include additional topics such as Testing :: Unit and Utilities, improving the discoverability and categorization of the project.

Syntax correction:🔗

  • Updated the requires-python field from ">3.9,<4.0" to ">=3.9,<4.0" to align with standard version specification syntax.

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.3.1...v1.3.2

Updates
  • eed97d8: Reorder classifiers and update Python requirement syntax in pyproject.toml (by chrimaho)

v1.3.1

v1.3.1 - Add more collection types🔗

🏷v1.3.1
📆2025-04-26
🔗data-science-extensions/toolbox-python/releases/v1.3.1

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.2.1...v1.3.1

Updates
  • c6e48f4: Add build target location so that hatchling knows exactly where the package directory is (by chrimaho)
  • c7e9d60: Add uv-lock and uv-lock-sync targets to Makefile (by chrimaho)
  • 8e7abfb: Add more collection types (by chrimaho)

v1.2.1

v1.2.1 - Add new @class_property decorator🔗

🏷v1.2.1
📆2025-04-25
🔗data-science-extensions/toolbox-python/releases/v1.2.1

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.2.0...v1.2.1

Updates
  • 95b0500: Fix Makefile for when using uv commands to make it more robust
    1. Add uv-shell command
    2. Update all commands to use --link-mode=copy (by chrimaho)
  • 8375044: Fix ignorances (by chrimaho)
  • 37d40aa: Enhance class_property decorator with additional class-level properties, and add unit tests with 100% coverage (by chrimaho)
  • 7878ad2: Add @class_property decorator and corresponding tests (by chrimaho)

v1.2.0

v1.2.0 - Migrate from Poetry to UV and add new DotDict class🔗

🏷v1.2.0
📆2025-04-06
🔗data-science-extensions/toolbox-python/releases/v1.2.0

Release Notes

Primary Changes🔗

  • Migrate build engine from Poetry to UV
  • Add new DotDict class to handle accessing dictionary keys using .attribute syntax
  • Add utility module bump_version for checking pyproject.toml and updating the version values across the respective files

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.1.0...v1.2.0

Updates

v1.1.0

v1.1.0 - Enhance the output module🔗

🏷v1.1.0
📆2025-02-24
🔗data-science-extensions/toolbox-python/releases/v1.1.0

Release Notes

What's Changed🔗

  • Update list_columns() function:
    • Allow the obj input to accept different input types
    • Extend the Unit Tests
  • Update pyproject.toml file:
    • To match the structure of the latest poetry version
    • To fix the location of where the __version__ attribute is stored

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.0.4...v1.1.0

Updates

v1.0.4

v1.0.4🔗

🏷v1.0.4
📆2024-12-13
🔗data-science-extensions/toolbox-python/releases/v1.0.4

Release Notes

What's Changed🔗

  • Fix type definitions across all modules.

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.0.3...v1.0.4

Updates

v1.0.3

v1.0.3🔗

🏷v1.0.3
📆2024-12-13
🔗data-science-extensions/toolbox-python/releases/v1.0.3

Release Notes

What's Changed🔗

  • Streamline a few functions in the Unit Tests module
  • Add dict_str_any object to the collection_types module

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.0.2...v1.0.3

Updates

v1.0.2

v1.0.2🔗

🏷v1.0.2
📆2024-11-10
🔗data-science-extensions/toolbox-python/releases/v1.0.2

Release Notes

What's Changed🔗

  • Refactor how the coverage reports are handled in the docs.

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.0.1...v1.0.2

Updates

v1.0.1

v1.0.1🔗

🏷v1.0.1
📆2024-11-10
🔗data-science-extensions/toolbox-python/releases/v1.0.1

Release Notes

What's Changed🔗

  • Fix some minor typos on the docs.

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.0.0...v1.0.1

Updates

v1.0.0

v1.0.0🔗

🏷v1.0.0
📆2024-11-05
🔗data-science-extensions/toolbox-python/releases/v1.0.0

Release Notes

What's Changed🔗

  • First major release.

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.1.1...v1.0.0

Updates

v0.10.3

v0.10.3🔗

🏷v0.10.3
📆2024-11-05
🔗data-science-extensions/toolbox-python/releases/v0.10.3

Release Notes

What's Changed🔗

  • Fix bugs in docs, and correct directory structure

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.10.2...v0.10.3

Updates

v0.10.2

v0.10.2🔗

🏷v0.10.2
📆2024-11-03
🔗data-science-extensions/toolbox-python/releases/v0.10.2

Release Notes

What's Changed🔗

  • Fix directory structure for docs

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.10.1...v0.10.2

Updates

v0.10.1

v0.10.1🔗

🏷v0.10.1
📆2024-11-03
🔗data-science-extensions/toolbox-python/releases/v0.10.1

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.9.1...v0.10.1

Updates

v0.9.1

v0.9.1🔗

🏷v0.9.1
📆2024-10-13
🔗data-science-extensions/toolbox-python/releases/v0.9.1

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.8.1...v0.9.1

Updates

v0.8.1

v0.8.1🔗

🏷v0.8.1
📆2024-10-13
🔗data-science-extensions/toolbox-python/releases/v0.8.1

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.7.1...v0.8.1

Updates

v0.7.1

v0.7.1🔗

🏷v0.7.1
📆2024-10-13
🔗data-science-extensions/toolbox-python/releases/v0.7.1

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.6.1...v0.7.1

Updates
  • 10e27e6: Add *_contains() functions to checkers module (by )

v0.6.1

v0.6.1🔗

🏷v0.6.1
📆2024-10-12
🔗data-science-extensions/toolbox-python/releases/v0.6.1

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.5.1...v0.6.1

Updates
  • 794dfcf: Add lists module and all unit tests (by )
  • effb9e8: Add more-itertools to main dependencies (by )

v0.5.1

v0.5.1🔗

🏷v0.5.1
📆2024-10-12
🔗data-science-extensions/toolbox-python/releases/v0.5.1

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.4.1...v0.5.1

Updates
  • 25aa9b8: Fix ci workflow triggers (by )
  • 4f95fce: Add strings module and all unit tests (by )

v0.4.1

v0.4.1🔗

🏷v0.4.1
📆2024-10-12
🔗data-science-extensions/toolbox-python/releases/v0.4.1

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.3.1...v0.4.1

Updates
  • cca2643: Add classes module and all unit tests (by )

v0.3.1

v0.3.1🔗

🏷v0.3.1
📆2024-10-12
🔗data-science-extensions/toolbox-python/releases/v0.3.1

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.2.1...v0.3.1

Updates
  • 744867a: Add defaults module and all unit tests (by )
  • 1d16d49: Fix typos (by )

v0.2.1

v0.2.1🔗

🏷v0.2.1
📆2024-10-12
🔗data-science-extensions/toolbox-python/releases/v0.2.1

Release Notes

What's Changed🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.1.1...v0.2.1

Updates
  • 553aaa1: Fix type bugs for Python 3.9 (by )
  • dc9c2b4: Complete unit tests for the checkers module (by )
  • 1a2c124: Fix mypy errors (by )
  • 3febc7d: Add the dictionaries module and unit tests (by )
  • ecd27bd: Streamline the unit tests for the bools module (by )
  • 44369f0: Expand collection_types module (by )
  • 60646e5: Add generic functions for unit tests (by )
  • 763ff0e: Fix install commands (by )
  • a1e4c59: Add parameterized to the test dependencies (by )
  • fb12849: Reformat the descriptions in the bools module (by )
  • fdeb865: Add the collection_types and checkers modules (by )
  • dbb9364: Fix version (by )
  • 92fc124: Add URLs back in to config (by )
  • 8f201c6: Fix version (by )
  • 00b3a7d: Add URLs back in to config (by )

v0.1.1

v0.1.1🔗

🏷v0.1.1
📆2024-10-12
🔗data-science-extensions/toolbox-python/releases/v0.1.1

Release Notes

What's Changed🔗

New Contributors🔗

Full Changelog: https://github.com/data-science-extensions/toolbox-python/commits/v0.1.1

Updates
  • f11e91d: Fix (by )
  • 4bbecc1: Clean up workflows (by )
  • 7efceca: Check whether git can checkout the main branch during workflow (by )
  • c1fd9d3: Check git switch to new branch (by )
  • 90fea6c: Fix missing git repo (by )
  • f0a1c86: Check Git details (by )
  • 3e09f81: Add process to push updated version back to Git main branch (by )
  • 993eafd: Hide URLs from pypoetry config file (by )
  • 1a022a4: Fix permissions in cd workflow (by )
  • b55ab3e: Add step to upload assets to the release, and also turn off --dry-run for pypi upload (by )
  • cf7b836: Add cd workflow (by )
  • 92dc8f9: Add more debugging scripts (by )
  • 05399bd: Fix typos (by )
  • bc96ae8: Enhance the ci workflow to do some debugging (by )
  • 5c84ff9: Extend ci workflow to include extensive checking when merge to main (by )
  • 46a91bf: Enhance poetry install commands (by )
  • 535084c: Add ci file to run checks when push to any branch except main (by )
  • 66e19af: Add Makefile commands (by )
  • 8243d1f: Hide pipenv config files (by )
  • 0c3f473: Clean comments (by )
  • 4be7347: Fix pre-commit config (by )
  • 04a237d: Enhance install scripts (by )
  • a95dd2a: Add all relevant modules (by )
  • 3dabcb5: Update main config file (by )
  • c767da2: Add pyupgrade to pre-commit config (by )
  • f6e4aea: Add .pre-commit config (by )
  • c7c257e: Add installation config and scripts (by )
  • 47795a7: Add info to bools module (by chrimaho)
  • 7a6a871: Add bools module (by chrimaho)
  • 94bad5d: Initial commit (by chrimaho)