Skip to content

Release v2.0.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 14 Aug 14:14
· 6 commits to master since this release
v2.0.0
1e9dff9
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

What's Changed

Added

  • New automated test reporting setup:
    • pytest.ini config to generate JUnit XML (reports\junit.xml) and coverage reports (XML and HTML in reports)
    • Added pytest-cov to dev dependencies; documented in README
  • Configuration via TOML using ConfZ with structured sections:
    • [generator]: probabilities and distributions for entity types, WID features, and person reuse
    • [downloader]: defaults for Bundesbank download (format, cache_dir, force_download, no_version_check)
    • [cli]: defaults for count, seed, output_format, output path and common flags (no_echo, iban_only, no_personal_info, no_bank_info, clean, no_color)
  • New CLI options:
    • --show-config-path to print the effective default config path
    • --config-dir to influence where config files are searched/written (used with subcommands)
  • New subcommand:
    • gen-ibans init to create a commented default config.toml (respects the top-level --config-dir when provided)
  • Colorized CLI help with highlighted option group headers for improved readability

Changed

  • CLI structure: switched to subcommands. The former top-level command is now gen-ibans gen, and gen-ibans-init-config is now gen-ibans init.
  • Standard config file switched from JSON to TOML; existing config.json files remain supported for backward compatibility
  • Config file search path now prioritizes the current working directory and then the user config directory
  • Help output: option group headers (click-option-group) are now highlighted consistently
  • Output examples and documentation updated to reflect current JSON, CSV, and XML structures
  • XML Output Format: Updated XML structure for better consistency
    • Root element changed from <ibans> to <accounts>
    • Individual entries changed from <iban><number> to <account><iban>
    • Maintains backward compatibility in terms of data content
  • Added MIT license header to all newly added source and test files

Fixed

  • Robust handling of config loading with ConfZ fallback to manual parsing; graceful failure on malformed configs
  • Improved stdout coloring control with --no-color and --clean

Updated

  • Dependencies: Added ConfZ and PlatformDirs; updated typing-extensions and related transitive dependencies

Breaking Changes

  • CLI now uses subcommands:
    • Generation is gen-ibans gen ... (was gen-ibans ...).
    • Config initialization is gen-ibans init (replaces separate gen-ibans-init-config).
  • Global options moved to the top-level: use gen-ibans --config-dir ... <subcommand> and gen-ibans --show-config-path.
  • The former gen-ibans gen --write-default-config option was removed. Use gen-ibans init (optionally with --path or top-level --config-dir).
  • Default config format is now TOML (config.toml). Existing config.json files are still supported for backward compatibility, but new default files are written as TOML.

New Contributors

Full Changelog: v1.0.1...v2.0.0

Contributors

swallat
Assets 4
Loading