Changelog

Version Index

Release Details

v1.4.2 (2025-12-18)

Highlights

• InvoiceFile.overwrite() now accepts dictionaries, validates them through InvoiceValidator, and can fall back to the existing invoice_path.
• Excel invoice reading is centralized inside ExcelInvoiceFile, with read_excelinvoice() acting as a warning-backed compatibility wrapper slated for v1.5.0 removal.
• csv2graph detects when a single series is requested and suppresses per-series plots unless the CLI flag explicitly demands them, keeping CLI and API defaults in sync.
• MultiDataTile pipelines continue to run—and therefore validate datasets—even when the input directory only contains Excel invoices or is empty.

Enhancements

• Updated InvoiceFile.overwrite() to accept mapping objects, apply schema validation through InvoiceValidator, and default the destination path to the instance’s invoice_path; refreshed docstrings and docs/rdetoolkit/invoicefile.md to describe the new API.
• Converted read_excelinvoice() into a wrapper that emits a deprecation warning and delegates to ExcelInvoiceFile.read(), updated src/rdetoolkit/impl/input_controller.py to use the class API directly, and clarified docstrings/type hints so df_general / df_specific may be None.
• Adjusted Csv2GraphCommand so no_individual is typed as bool | None, added CLI plumbing that inspects ctx.get_parameter_source() to detect explicit user input, and documented the overlay-only default in docs/rdetoolkit/csv2graph.md.
• Added assert_optional_frame_equal and new regression tests that cover csv2graph CLI/API flows plus MultiFileChecker behaviors for Excel-only, empty, single-file, and multi-file directories.

Fixes

• Auto-detecting single-series requests avoids generating empty per-series artifacts and aligns CLI defaults with the Python API.
• _process_invoice_sheet(), _process_general_term_sheet(), and _process_specific_term_sheet() now correctly return pd.DataFrame objects, avoiding attribute errors in callers that expect frame operations.
• MultiFileChecker.parse() returns [()] when no payload files are detected so MultiDataTile validation runs even on empty input directories, matching Invoice mode semantics.

Migration / Compatibility

• Code calling InvoiceFile.overwrite() can now supply dictionaries directly; omit the destination argument to write to the instance path, and expect schema validation errors when invalid structures are provided.
• read_excelinvoice() is officially deprecated and scheduled for removal in v1.5.0—migrate to ExcelInvoiceFile().read() or ExcelInvoiceFile.read() helpers.
• csv2graph now generates only the overlay/summary graph when --no-individual is not specified and there is one (or zero) value columns; pass --no-individual=false to force legacy per-series output or --no-individual to always skip them.
• MultiDataTile runs on empty directories no longer short-circuit; expect validation failures to surface when required payload files are absent.

Known Issues

• None reported at this time.

v1.4.1 (2025-11-05)

Highlights

• Dedicated SmartTable row CSV accessors replace ad-hoc rawfiles[0] lookups without breaking existing callbacks.
• MultiDataTile workflows now guarantee a returned status and surface the failing mode instead of producing silent job artifacts.
• CSV parsing tolerates metadata comments and empty data windows, removing spurious parser exceptions.
• Graph helpers (csv2graph, plot_from_dataframe) are now exported directly via rdetoolkit.graph for simpler imports.

Enhancements

• Introduced the smarttable_rowfile field on RdeOutputResourcePath and exposed it via ProcessingContext.smarttable_rowfile and RdeDatasetPaths.
• SmartTable processors populate the new field automatically; when fallbacks hit rawfiles[0] a FutureWarning is emitted to prompt migration while preserving backward compatibility.
• Refreshed developer guidance so SmartTable callbacks expect the dedicated row-file accessor.
• Re-exported csv2graph and plot_from_dataframe from rdetoolkit.graph, aligning documentation and samples with the simplified import path.

Fixes

• Ensured MultiDataTile mode always returns a WorkflowExecutionStatus and raises a StructuredError that names the failing mode if the pipeline fails to report back.
• Updated CSVParser._parse_meta_block() and _parse_no_header() to ignore #-prefixed metadata rows and return an empty DataFrame when no data remains, eliminating ParserError / EmptyDataError.

Migration / Compatibility

• Existing callbacks using resource_paths.rawfiles[0] continue to work, but now emit a FutureWarning; migrate to smarttable_rowfile to silence it.
• The rawfiles tuple itself remains the primary list of user-supplied files—only the assumption that its first entry is always the SmartTable row CSV is being phased out.
• No configuration changes are required for CSV ingestion; the parser improvements are backward compatible.
• Prefer from rdetoolkit.graph import csv2graph, plot_from_dataframe; the previous rdetoolkit.graph.api path remains available for now.

Known Issues

• None reported at this time.

v1.4.0 (2025-10-24)

Highlights

• SmartTableInvoice automatically writes meta/ columns to metadata.json
• Compact AI/LLM-friendly traceback output (duplex mode)
• CSV visualization utility csv2graph
• Configuration scaffold generator gen-config

Enhancements

• Added the csv2graph API with multi-format CSV support, direction filters, Plotly HTML export, and 220+ tests.
• Added the gen-config CLI with template presets, bilingual interactive mode, and --overwrite safeguards.
• SmartTableInvoice now maps meta/ prefixed columns—converted via metadata-def.json—into the constant section of metadata.json, preserving existing values and skipping if definitions are missing.
• Introduced selectable traceback formats (compact, python, duplex) with sensitive-data masking and local-variable truncation.
• Consolidated RDE dataset callbacks around a single RdeDatasetPaths argument while emitting deprecation warnings for legacy signatures.

Fixes

• Resolved a MultiDataTile issue where StructuredError failed to stop execution when ignore_errors=True.
• Cleaned up SmartTable error handling and annotations for more predictable failure behavior.

Migration / Compatibility

• Legacy two-argument callbacks continue to work but should migrate to the single-argument RdeDatasetPaths form.
• Projects using SmartTable meta/ columns should ensure metadata-def.json is present for automatic mapping.
• Traceback format configuration is optional; defaults remain unchanged.

Known Issues

• None reported at this time.

v1.3.4 (2025-08-21)

Highlights

• Stabilized SmartTable/Invoice validation flow.

Enhancements

• Reworked validation and initialization to block stray fields and improve exception messaging.

Fixes

• Addressed SmartTableInvoice validation edge cases causing improper exception propagation or typing mismatches.

Migration / Compatibility

• No breaking changes.

Known Issues

• None reported at this time.

v1.3.3 (2025-07-29)

Highlights

• Fixed ValidationError construction and stabilized Invoice processing.
• Added sampleWhenRestructured schema for copy-restructure workflows.

Enhancements

• Introduced the sampleWhenRestructured pattern so copy-restructured invoice.json files requiring only sampleId validate correctly.
• Expanded coverage across all sample-validation patterns to preserve backward compatibility.

Fixes

• Replaced the faulty ValidationError.__new__() usage with SchemaValidationError during _validate_required_fields_only checks.
• Clarified optional fields for InvoiceSchemaJson and Properties, fixing CI/CD mypy failures.

Migration / Compatibility

• No configuration changes required; existing invoice.json files remain compatible.

Known Issues

• None reported at this time.

v1.3.2 (2025-07-22)

Highlights

• Strengthened required-field validation for SmartTableInvoice.

Enhancements

• Added schema enforcement to restrict invoice.json to required fields, preventing unnecessary defaults.
• Ensured validation runs even when pipelines terminate early.

Fixes

• Tidied exception handling and annotations within SmartTable validation.

Migration / Compatibility

• Backward compatible, though workflows adding extraneous invoice.json fields should remove them.

Known Issues

• None reported at this time.

v1.3.1 (2025-07-14)

Highlights

• Fixed empty-sheet exports in Excel invoice templates.
• Enforced stricter validation for extended_mode.

Enhancements

• Added serialization_alias to invoice_schema.py, ensuring $schema and $id serialize correctly in invoice.schema.json.
• Restricted extended_mode in models/config.py to approved values and broadened tests for save_raw / save_nonshared_raw behavior.
• Introduced save_table_file and SkipRemainingProcessorsError to SmartTable for finer pipeline control.
• Updated models/rde2types.py typing and suppressed future DataFrame warnings.
• Refreshed Rust string formatting, build.rs, and CI workflows for reliability.

Fixes

• Added raw-directory existence checks to prevent copy failures.
• Ensured generalTerm / specificTerm sheets appear even when attributes are empty and corrected variable naming errors.
• Specified orient in FixedHeaders to silence future warnings.

Migration / Compatibility

• Invalid extended_mode values now raise errors; normalize configuration accordingly.
• Review SmartTable defaults if relying on prior save_table_file behavior.
• tqdm dependency removal may require adjustments in external tooling.

Known Issues

• None reported at this time.

v1.2.0 (2025-04-14)

Highlights

• Introduced MinIO storage integration.
• Delivered artifact archiving and report-generation workflows.

Enhancements

• Implemented the MinIOStorage class for object storage access.
• Added commands for archive creation (ZIP / tar.gz) and report generation.
• Expanded documentation covering object-storage usage and reporting APIs.

Fixes

• Updated dependencies and modernized CI configurations.

Migration / Compatibility

• Fully backward compatible; enable optional dependencies when using MinIO.

Known Issues

• None reported at this time.