cement/CHANGELOG.md

ChangeLog

3.0.11 - DEVELOPMENT (will be released as stable/3.0.12)

Bugs:

• ?

Features:

• ?

Refactoring:

• [dev] Refactor String Substitutions (%s) with F-Strings
  • Issue #733
• [dev] Allow line lengths up to 100 characters (previously 78)
• [dev] Modernize Packaging (pyproject.toml, PDM)
  • Issue #680
  • PR #681
• [dev] Implement Ruff for Code Compliance (replaces Flake8)
  • Issue #671
  • PR #681
• [dev] Remove Python 3.5, 3.6, 3.7 Docker Dev Targets
• [dev] Added Python 3.13 Dev Target
• [dev] Type Annotations (related: PR #628)
  • [core.arg] Issue #692
  • [core.cache] Issue #693
  • [core.config] Issue #694
  • [core.controller] Issue #695
  • [core.deprecations] Issue #696
  • [core.exc] Issue #697
  • [core.extension] Issue #698
  • [core.foundation] Issue #699
  • [core.handler] Issue #700
  • [core.hook] Issue #700
  • [core.interface] Issue #702
  • [core.log] Issue #703
  • [core.mail] Issue #704
  • [core.meta] Issue #705
  • [core.output] Issue #706
  • [core.plugin] Issue #707
  • [core.template] Issue #708
  • [ext.alarm] Issue #709
  • [ext.argparse] Issue #710
  • [ext.colorlog] Issue #711
  • [ext.configparser] Issue #712
  • [ext.daemon] Issue #713
  • [ext.dummy] Issue #714
  • [ext.generate] Issue #715
  • [ext.jinja2] Issue #716
  • [ext.json] Issue #717
  • [ext.logging] Issue #718
  • [ext.memcached] Issue #719
  • [ext.mustache] Issue #720
  • [ext.plugin] Issue #721
  • [ext.print] Issue #722
  • [ext.redis] Issue #723
  • [ext.scrub] Issue #724
  • [ext.smtp] Issue #725
  • [ext.tabulate] Issue #726
  • [ext.watchdog] Issue #727
  • [utils.fs] Issue #688
  • [utils.misc] Issue #689
  • [utils.shell] Issue #690
  • [utils.version] Issue #691

Misc:

• ?

Deprecations:

• ?

Special Recognitions:

Many thanks to @sigma67 for their contributions in modernizing the packaging system. Cement was started in 2009, and has some lingering technical debt that is now being addressed. Their contribution was a major help in moving off of setuptools and on to PDM and pyproject.toml, along with initial implementations of Ruff for a new generation of code compliance. I sincerely appreciate your help!

Many thanks to @rednar for their contributions toward adding type annotations in PR #628. This PR was too large to merge directly, but it is serving as a guide to finally begin work toward adding type annotations to Cement. This was a massive effort, and is very helpful to have this work available to guide the effort even if it will not be merged directly.

3.0.10 - Feb 28, 2024

Bugs:

• [ext.logging] Support logging.propagate to avoid duplicate log entries
  • Issue #310
• [core.foundation] Quiet mode file is never closed
  • Issue #653
• [ext.smtp] Ability to Enable TLS without SSL
  • Issue #667
• [ext.smtp] Empty (wrong) addresses sent when CC/BCC is None
  • Issue #668

Features:

• [utils.fs] Add Timestamp Support to fs.backup
  • Issue #611
• [ext.smtp] Support for sending file attachements.
  • PR #669
• [ext.smtp] Support for sending both Plain Text and HTML
  • PR #669

Refactoring:

• [core.plugin] Deprecate the use of imp in favor of importlib
  • Issue #386
• [ext.smtp] Actually test SMTP against a real server (replace mocks)

Misc:

• [dev] Add Smoke tests for Python 3.11, 3.12
• [dev] Make Python 3.12 the default development target
• [dev] Drop support for Python 3.7
  • Issue #658
• [docker] Base official Docker image on Python 3.12
• [utils.version] Resolve deprecated datetime.utcfromtimestamp()
  • Issue #661
• [dev] Add comply-typing to make helpers, start working toward typing.
  • Issue #599
  • PR #628
• [dev] Add mailpit service to docker-compose development config.

Deprecations:

• [ext.logging] Deprecate FATAL facility in favor of CRITICAL.
  • Issue #533

3.0.8 - Aug 18, 2022

Bugs:

• [cli] Cement CLI broken on Python 3.10
  • Issue #619
• [cli] Generated script returns version of Cement
  • Issue #632
• [cli] Generated script should allow dash/underscore
  • Issue #614
• [core.foundation] App.render() not suppressed in quiet mode
  • Issue #636
• [core.foundation] Console log not suppressed by output handler override (JSON/YAML)
  • Issue #637

Features:

• [utils.shell] Support suppress meta option on Prompt to suppress user input.
  • Issue #621
• [ext] Use extras_require for optional extensions
  • Issue #604

Refactoring:

• [utils.misc] Use SHA256 instead of MD5 in rando() to support Redhap/FIPS compliance
  • Issue #626
• [core.foundation] Make quiet/debug options configurable
  • Issue #613

Misc:

• [dev] Cement CLI smoke tests
  • Issue #620
• [dev] Add Python 3.10 to Travis CI tests
  • Issue #618
• [core.deprecations] Implement Cement deprecation warnings
  • Issue #631

Deprecations:

• [core.foundation] Deprecate CEMENT_FRAMEWORK_LOGGING in favor of CEMENT_LOG.
  • Issue #638

3.0.6 - Dec 18, 2021

Bugs:

• [ext.argparse] Parser (self._parser) not accessible inside _pre_argument_parsing when stacked_type = 'embedded'
  • Issue #569
• [ext.configparser] Overriding config options with environment variables doesn't work correctly with surrounding underscore characters
  • Issue #590
• [utils.fs] Fix bug where trailing slash was not removed in fs.backup() of a directory.
  • Issue #610
• [cement.cli] Generated README contains incorrect installation instructions.
  • Issue #588

Features:

• None

Refactoring:

• [ext.colorlog] Support subclassing of ext_colorlog.
  • Issue #571

Misc:

• [dev] Update to Python 3.10 for default development / Docker version.
• [dev] Remove Python 3.5/3.6 from Travis CI tests.

3.0.4 - May 17, 2019

Bugs:

• [ext.yaml] YamlConfigHandler uses unsafe load method
  • Issue #553
• [ext.configparser] Configparser 'getboolean' exception
  • Issue #558

Features:

• [utils.misc] Support y as a truth boolean in utils.misc.is_true
  • Issue #542

3.0.2 - November 6, 2018

Bugs:

• [cli] Generate Variable Mishap in Project Template
  • Issue #532
• [ext.generator] Error class is malformed
  • Issue #535
• [core.template] MemoryError during 'cement generate project'
  • Issue #531
• [core.foundation] Contents of plugin_dirs is printed to console
  • Issue #538

Features:

• [ext.argparse] Command name override
  • Issue #529

3.0.0 - August 21, 2018

Bugs:

• [ext.redis] Unable To Set Redis Host
  • Issue #440
• [ext.argparse] Empty Sub-Commands List
  • Issue #444
• [core.foundation] Handler Override Options Do Not Honor Meta Defaults
  • Issue #513

Features:

• [core] Add Docker / Docker Compose Support
  • Issue #439
• [core] Add ability to override the output handler used when app.render() is called.
  • Issue #471
• [ext.print] Add the Print Extension to be used as a drop in replacement for the standard print(), but allowing the developer to honor framework features like pre_render and post_render hooks.
• [ext.scrub] Add Scrub Extension to easily obfuscate sensitive data from rendered output.
  • Issue #469
• [core] Add ability to override config settings via environment variables.
  • Issue #437
• [ext.argparse] Add ability to get list of exposed commands
  • Issue #455
• [core] Add Template Interface
  • Issue #464
• [ext.mustache] Add MustacheTemplateHandler
• [ext.handlebars] Add HandlebarsTemplateHandler
• [ext.jinja2] Add Jinja2TemplateHandler
• [ext.generate] Add Generate Extension
  • Issue #487
• [ext.logging] Add -l LEVEL command line option to override log level
  • Issue #497
• [cli] Add Cement CLI (includes ability to generate apps, plugins, extensions, and scripts using the Generate Extension)
  • Issue #490
• [core] Added clear separation between Interfaces and Handlers
  • Issue #506
• [utils.fs] - Added several helpers include fs.Tmp for creation and cleanup of temporary directory and file.

Refactoring:

• Too many to reference

Incompatible:

• [core] Replace Interfaces with ABC Base Classes
  • Issue #192
• [core.foundation] Rename CementApp to App.
• [core.foundation] Drop deprecated App.Meta.override_arguments
• [core.foundation] Remove App.Meta.plugin_config_dir and App.Meta.plugin_config_dirs in favor of App.Meta.config_dirs
  • Issue #521
• [core.founcation] Rename App.Meta.plugin_bootstrap as App.Meta.plugin_module
  • Issue #523
• [core.handler] Rename CementBaseHandler to Handler
• [core.handler] Drop deprecated backend globals
• [core.hook] Drop deprecated backend globals
• [core.controller] Drop CementBaseController
• [ext.logging] Drop deprecated warn facility (use warning)
• [ext.argcomplete] Drop ArgComplete Extension
• [ext.reload_config] Drop Reload Config Extension
• [ext.configobj] Drop ConfigObj Extension
• [ext.json] Disable overridable option by default
• [ext.yaml] Disable overridable option by default
• [ext.json_configobj] Drop JSON ConfigObj Extension
• [ext.yaml_configobj] Drop YAML ConfigObj Extension
• [ext.handlebars] Drop Handlebars Extension
• [ext.genshi] Drop Genshi Extension
• [ext.argparse] ArgparseController.Meta.default_func is now _default, and will print help info and exit. Can now set this to None as well to pass/exit.
  • Issue #426
• [ext.plugin] All plugin configuration sections must start with plugin.. For example, [plugin.myplugin].
• [core.foundation] Renamed App.Meta.config_extension to App.Meta.config_file_suffix
  • Issue #445
• [core.foundation] Drop App.Meta.arguments_override_config
  • Issue #493

Deprecation:

• Everything with deprecation notices in Cement < 3