Change Log
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
andREPOSITORY_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๐
- Documentation Infrastructure Enhancement and Automated Changelog Generation by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/37
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.4.0...v1.4.1
Updates
-
Refactor release notes and commit message formatting for improved readability and maintainability (by chrimaho) View
-
Add environment variable checks for
GITHUB_TOKEN
andREPOSITORY_NAME
(by chrimaho) View -
Add process for generating changelog during CD pipeline (by chrimaho) View
-
Add process for generating shortcodes in docs (by chrimaho) View
-
Hide the lines in the CD workflow which are causing issues (by chrimaho) View
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
, andnot 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
andassert_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 typestoolbox_python.output.list_columns()
- Distinguishes between print and return modestoolbox_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 withmin()
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 combinedlint()
- Checking:
check_black()
,check_mypy()
,check_pytest()
,check_codespell()
,check_pylint()
, and comprehensivecheck()
- 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 inpyproject.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 detailscheck_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 structurecheck_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 withuv 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 withuv 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
touv_build
for better integration with UV toolchain and improved build reliability - MyPy configuration: Updated to include
no-redef
indisable_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
tomaterial/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 newstr_to_list()
function with various input types - Expanded
src/tests/test_checkers.py
- Comprehensive tests for new validation functions includingOPERATORS
testing - Test improvements: Updated existing tests to use
pytest.raises
instead ofpytest
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๐
- Reorder classifiers and update Python requirement syntax in
pyproject.toml
by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/35 - Comprehensive Package Enhancement and Tooling Migration with new modules, improved validation, and modernized CI/CD workflows by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/36
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
-
Fix echo command to use -E flag for proper interpretation of escape sequences (by chrimaho) View
-
Temporarily turn off pypi deployment step (by chrimaho) View
-
Refactor versioning commands to accept version as an argument and update related CLI functions (by chrimaho) View
-
Fix bug in the CD debugging job
In the CD workflow, when it will throw an error for thegithub.event.release.name
andgithub.event.release.body
when they contain code which is surrounded by the back-tick:<br> This is because the
echo` will escape the back-tick and try to execute the inner text as a command.
This is undesirable behaviour. (by chrimaho) View -
Fix version bump command and improve regex pattern matching to ensure correct and accurate execution (by chrimaho) View
-
Refactor
git
command executions to improve reliability, expandability and readability (by chrimaho) View -
Fix bug in the
scripts.git_add_coverage_report()
function (by chrimaho) View -
Fix typo in
generators
module
Co-authored-by: Copilot 175728472+Copilot@users.noreply.github.com (by chrimaho) View -
Fix typo in
retry
module
Co-authored-by: Copilot 175728472+Copilot@users.noreply.github.com (by chrimaho) View -
Refactor test files to replace any
import pytest
withfrom pytest import ...
for improved consistency (by chrimaho) View -
Add input validation for retry parameters using
assert_is_valid
(by chrimaho) View -
Refactor CD workflow to replace all 'make' commands with 'uv run' commands for improved consistency and performance (by chrimaho) View
-
Reorganise the
[project.scripts]
table -
Move
scripts.py
fromsrc/cli
tosrc/utils
and add functions to handlegit
anddocs
processes (by chrimaho) View -
Update
bump_version
util to be better compatable with CLI execution (by chrimaho) View -
Add
git_checks.sh
script to capture git logs and diffs (by chrimaho) View -
Refactor CI and CD workflows to replace 'make' commands with 'uv' commands for installations and checks (by chrimaho) View
-
Add a more robust way of capturing errors when checking docstrings (by chrimaho) View
-
Fix typos in all docstrings
-> From!!! summary "Summary"
-> To!!! note "Summary"
(by chrimaho) View -
Add functions to check docstrings in all Python files and in a specific directory (by chrimaho) View
-
Refactor command execution to support space expansion and simplify command syntax (by chrimaho) View
-
Add project scripts and update build system dependencies (by chrimaho) View
-
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) View
- Implements automated docstring checking with strict formatting requirements including mandatory Summary, Params, Returns/Yields, and Examples sections.
-
Improve
checkers
module documentation and formatting (by chrimaho) View -
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) View
- 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.
-
Refactors exception handling for the
retry()
function and add logging initialization -
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) View
- Enhances function robustness by adding comprehensive parameter validation using assertion functions to ensure type safety and value constraints.
-
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) View
- Introduces a new utility function that converts strings to single-element lists while preserving other data types unchanged.
-
Add additional
@overload
's forlist_columns
andretry
functions to better enhance type hints in theoutput
andretry
modules (by chrimaho) View -
Update
pre-commit
hooks versions and remove outdated poetry check (by chrimaho) View -
Update all code docstrings examples to use
pycon
syntax for better clarity, and refine theRaises
statements (by chrimaho) View -
Significant improvements to the
checkers
module- Added
OPERATORS
constant dictionary to define comparison operations. - Introduced
is_valid_value
andassert_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) View
- Added
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๐
- Reorder classifiers and update Python requirement syntax in
pyproject.toml
by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/35
Metadata improvements:๐
- Reorganized and expanded the
classifiers
section to include additional topics such asTesting :: Unit
andUtilities
, 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
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๐
- Add more Collection types by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/34
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.2.1...v1.3.1
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๐
- Add new
@class_property
decorator by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/33
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.2.0...v1.2.1
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 checkingpyproject.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
-
Fix bug in
src/toolbox_python/dictionaries.py::DotDict.to_dict()
Co-authored-by: Copilot 175728472+Copilot@users.noreply.github.com (by chrimaho) View -
Extend UnitTests for the
dictionaries
module (by chrimaho) View -
Refactor
cd
workflow to useuv
for building and publishing packages (by chrimaho) View -
Add new
DotDict
class to thedictionaries
module (by chrimaho) View -
Update CI/CD workflows to use
uv
processes (by chrimaho) View -
Update package config to use
uv
instead ofpoetry
(by chrimaho) View
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
- Allow the
- Update
pyproject.toml
file:- To match the structure of the latest
poetry
version - To fix the location of where the
__version__
attribute is stored
- To match the structure of the latest
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.0.4...v1.1.0
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
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 thecollection_types
module
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v1.0.2...v1.0.3
Updates
-
Streamline
deployment
steps in theMakefile
(by chrimaho) View -
Add
dict_str_any
tocollection_types
module (by chrimaho) View -
Add
docstring-inheritance
todocs
dependencies (by chrimaho) View -
Fix missing Python version check during
CI
workflow (by chrimaho) View -
Hide
.js
and.css
from GitHub language stats (by chrimaho) View -
Update package dependencies to make them more flexible (by chrimaho) View
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
-
Re-enable
PyPI
deployment duringCD
workflow (by chrimaho) View -
Enhance
CD
workflow to better handle Code Cov reports (by chrimaho) View -
Fix
mike
config to removedeploy-prefix
setting (by chrimaho) View -
Remove unnecessary
code-cov
flags in thepytest
config (by chrimaho) View -
Streamline
Makefile
to remove unnecessary recipes, and add one to copy code-cov reports (by chrimaho) View -
Remove unnecessary variables in the
CD
workflow (by chrimaho) View -
Remove unnecessary
deploy-docs
job fromCD
workflow (by chrimaho) View -
Add
git config
using both--global
and--local
flags (by chrimaho) View
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
-
Add
git config
using both--global
and--local
flags (by chrimaho) View -
Do testing on env variables parsed to
make
commands (by chrimaho) View -
Add permissions again to
CD
workflow file (by chrimaho) View -
Enhance
Makefile
to make recipes more robust and also add--remote=docs
flag to allmike
commands (by chrimaho) View
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
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
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
-
Fix missing
pypi
token from thedeploy-package
job in thecd
workflow (by chrimaho) View -
Fix artifacts used between jobs in the
cd
workflow (by chrimaho) View -
Restructure how the
cd
workflow works, splitting out thebuild
anddeploy
steps for both thepypi
anddocs
jobs (by chrimaho) View -
Rearrange the directory structure for the docs (by chrimaho) View
-
Fix
docs
commands forbuild
/serve
processes (by chrimaho) View -
Fix
deploy_prefix
formike
docs deployments (by chrimaho) View
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๐
- Add Documentation by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/28
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.9.1...v0.10.1
Updates
-
Fix
actions/setup-python
version in GitHub Actions (by chrimaho) View -
Update versions in
pre-commit
config file (by chrimaho) View -
Add
ipykernel
to list ofdev
dependencies (by chrimaho) View -
Enhance the custom
css
for bothadmonitions
andcode-chunks
(by chrimaho) View -
Fix examples for the docstrings in all functions in all modules. (by chrimaho) View
-
Fix typos in the
Examples
sections for each of the docstrings (by chrimaho) View -
Fix missing exports from the
checkers
module (by chrimaho) View -
Update unit tests for the
checkers
module (by chrimaho) View -
Fix failing unit tests from the
lists
module (by chrimaho) View -
Expand predefined types from the
collection_types
module (by chrimaho) View -
Finish adding docs to the
checkers
module (by chrimaho) View -
Set up configuration for the
mkdocs
documentation (by chrimaho) View
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๐
- Add
retry
module and all unit tests by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/26
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.8.1...v0.9.1
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๐
- Add
output
module and all unit tests by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/25
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.7.1...v0.8.1
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๐
- Add
*_contains()
functions tocheckers
module by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/23
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.6.1...v0.7.1
Updates
- Add
*_contains()
functions tocheckers
module (by ) View
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๐
- Add
lists
module by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/22
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.5.1...v0.6.1
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๐
- Add
strings
module and all unit tests by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/21
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.4.1...v0.5.1
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๐
- Add
classes
module by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/16
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.3.1...v0.4.1
Updates
- Add
classes
module and all unit tests (by ) View
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๐
- Add
defaults
module by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/15
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.2.1...v0.3.1
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๐
- Add URLs back in to config by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/9
- Fix Merge config by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/10
- Add
dictionaries
module and all Unit Tests by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/11
Full Changelog: https://github.com/data-science-extensions/toolbox-python/compare/v0.1.1...v0.2.1
Updates
-
Fix type bugs for Python 3.9 (by ) View
-
Complete unit tests for the
checkers
module (by ) View -
Fix
mypy
errors (by ) View -
Add the
dictionaries
module and unit tests (by ) View -
Streamline the unit tests for the
bools
module (by ) View -
Expand
collection_types
module (by ) View -
Add generic functions for unit tests (by ) View
-
Fix install commands (by ) View
-
Add
parameterized
to thetest
dependencies (by ) View -
Reformat the descriptions in the
bools
module (by ) View -
Add the
collection_types
andcheckers
modules (by ) View -
Fix version (by ) View
-
Add URLs back in to config (by ) View
-
Fix version (by ) View
-
Add URLs back in to config (by ) View
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๐
- Updates by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/1
- Dev by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/2
- Dev by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/3
- Dev by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/4
- Dev by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/5
- Dev by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/6
- Dev by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/7
- Dev by @chrimaho in https://github.com/data-science-extensions/toolbox-python/pull/8
New Contributors๐
- @chrimaho made their first contribution in https://github.com/data-science-extensions/toolbox-python/pull/1
Full Changelog: https://github.com/data-science-extensions/toolbox-python/commits/v0.1.1
Updates
-
Fix (by ) View
-
Clean up workflows (by ) View
-
Check whether
git
can checkout themain
branch during workflow (by ) View -
Check
git
switch to new branch (by ) View -
Fix missing
git
repo (by ) View -
Check Git details (by ) View
-
Add process to push updated version back to Git
main
branch (by ) View -
Hide URLs from
pypoetry
config file (by ) View -
Fix permissions in
cd
workflow (by ) View -
Add step to upload assets to the release, and also turn off
--dry-run
for pypi upload (by ) View -
Add
cd
workflow (by ) View -
Add more debugging scripts (by ) View
-
Fix typos (by ) View
-
Enhance the
ci
workflow to do some debugging (by ) View -
Extend
ci
workflow to include extensive checking when merge tomain
(by ) View -
Enhance poetry install commands (by ) View
-
Add
ci
file to run checks when push to any branch exceptmain
(by ) View -
Add
Makefile
commands (by ) View -
Hide
pipenv
config files (by ) View -
Clean comments (by ) View
-
Fix
pre-commit
config (by ) View -
Enhance install scripts (by ) View
-
Add all relevant modules (by ) View
-
Update main config file (by ) View
-
Add
pyupgrade
topre-commit
config (by ) View -
Add
.pre-commit
config (by ) View -
Add installation config and scripts (by ) View