You're reading an old version of this documentation. For up-to-date information, please have a look at v0.6.

Changelog

This page contains a summary of changes between the official pymetacode releases. Only the biggest changes are listed here. A complete and detailed log of all changes is available through the GitHub Repository Browser.

Version 0.5.1

Released 2024-02-01

Fixes

• pymetacode.coding.ClassCreator properly checks for existing class, not only for an existing class starting with the name of the class to be added.

• pymetacode.coding.FunctionCreator properly checks for existing function, not only for an existing function starting with the name of the function to be added.

Version 0.5.0

Released 2024-01-13

New features

• Configuration option for license (default: “BSD”)

  • Added GPLv3 as possible license

• GUI

  • GUI code based on package qtbricks

  • Creating/adding GUI widgets

  • Creating/adding GUI dialogs

• Creating/adding subpackages

  • Adding modules, classes, and functions to subpackages using dot notation separating subpackage and module: mysubpackage.mymodule

• Automatic code formatting using Black

  • A git pre-commit hook is added formatting all currently staged files.

• Makefile for automating recurring tasks during development

  • create documentation using Sphinx

  • run unittests

  • check code using prospector

  • format code using Black

• CITATION.cff file with basic content

• Logo

Changes

• Rename gui subdirectory: ‘data’ -> ‘images’

• README and documentation index are now independent and differ slightly in their content.

• Code reformatted using Black

Fixes

• Makefile in gui subdirectory: indentation with tabs

• app.py: add missing imports

• MANIFEST.in includes package name for recursive-include

• setup.py includes “include_package_data” statement

Version 0.4.0

Released 2023-09-27

New features

• Configuration option for language of documentation (default: “en”)

• Function pymetacode.utils.make_executable() to set executable flag for files/paths

• Creating/adding GUI and GUI windows (based on Qt6 and PySide6)

• Adding functions/classes checks for their existence, not overriding them (any more)

Changes

• Transition from discontinued appdirs package to platformdirs package

• pymetacode.utils.ToDictMixin returns dict rather than collections.OrderedDict, as dicts are order-preserving since Python 3.7

• Removed dependency on oyaml package from setup.py

Version 0.3.1

Released 2023-09-22

New features

• MANIFEST.in file (for README, LICENSE, VERSION)

• CITATION.cff file

Version 0.3.0

Released 2021-09-23

New features

• Templates adjustable by user (local install)

• Logging added in modules on request in config file

• Templates can be retrieved for other package, prefixing the template name with the package name (see pymetacode.utils.get_package_data() for details)

Changes

• pymetacode.configuration.Configuration with new property options

  (Important: Requires updating existing configuration files)

Fixes

• Whitespace in apidoc index preventing proper sphinx build

Version 0.2.0

Released 2021-09-21

New features

• Full sphinx-multiversion support (including version switcher and banner)

• Prospector profile gets added to project.

• Alphabetical sorting of modules in API index.

• Docstrings of classes and modules contain “versionadded” only if version > 0.1, and with correct version.

Bug fixes

• Whitespace in setup.py (spurious empty lines)

Version 0.1.1

Released 2021-09-01

The following bugs have been fixed:

• Permission of the version incrementer

• Templates are contained in package

Version 0.1.0

Released 2021-09-01

• First public release

• Create initial package structure (directory layout, files)

• Add module, class, and function scaffolds to an existing project, including tests and API documentation

• Intuitive command-line interface (CLI)