Change Log

This document records the main changes to the python-template code.

Next release

✨ Improved

3.0.0 (2026-03-02)

  • #26 Update the template to version 3 using copier instead of cookiecutter and updating the documentation and style guide.

View commits since the last tag

2.1.0 (2021-03-24)

🚀 New

  • GitHub workflow for testing.

✨ Improved

  • Updated dependencies.

  • Removed the requirements docs extra. Instead, documentation extra packages are defined in a requirements.txt in docs/sphinx and automatically installed in the RTD build.

🔧 Fixed

  • Link to the standards in the README.

View commits

2.0.0 (2020-04-13)

✨ Improved

  • Dropped support for Python 2.

  • Move style guide to root level.

  • Use setup.cfg for packaging and configuration of pytest, flake8, isort, and coverage.

  • Move tests outside of the package to simplify packaging.

  • Replace utils with sdsstools.

  • Remove use of bumpversion. Instead, get the package version using sdsstools.get_package_version.

  • Updated the template Sphinx docs.

  • Updated style guide and documentation.

  • Allow to choose between setuptools and poetry.

  • Allow to choose between sphinx-bootstrap-theme and alabaster.

View commits

1.0.6 (2019-12-31)

🚀 New

  • Avoid connecting more than one console handler to the warnings log.

🔧 Fixed

  • Do not modify the record when formatting it, in case that record is also output in other handlers.

View commits

1.0.5 (2019-05-13)

Backward incompatible changes

  • The default path for the user configuration file is now ~/.config/<name>/<name>.yml.

🚀 New

  • Better handling of configuration files. An environment variable $<NAME>_CONFIG_PATH (e.g., $MYPYTHON_CONFIG_PATH) can be defined to point to the user configuration file. If defined, this path overrides the default location.

✨ Improved

  • Modified logger to deal with warnings. Added critical level printing. Fixes #12 and #13.

🔧 Fixed

  • Bug causing Python 2.7 templates to fail because PercentStyle is not available in logging module (thanks to @andycasey).

View commits

1.0.4 (2019-01-18)

✨ Improved

  • Updated year in template to 2019.

🔧 Fixed

  • More fixes to quotes in module-whatis in module file.

View commits

1.0.3 (2018-12-10)

🔧 Fixed

  • Quotes in module-whatis in module file.

View commits

1.0.2 (2018-10-01)

🔧 Fixed

  • Remove from __future__ import unicode_literals that made the package install fail under Python 2. See #9 for details.

View commits

1.0.1 (2018-07-30)

🚀 New

  • Added W0621 to disabled list in pylint.

✨ Improved

  • Changed documentation font size.

  • Modified code and readthedocs configuration to use Python 3.6.

  • Remove logger warning monkeypatching since it conflicted when used with packages that provide a similar monkeypatching. Replaced with a custom logging.warning method that produces coloured warning output.

  • The package_name specified when cookiecutting the template is applied in lowercase when creating the package but in ucfirst case when creating classes.

  • Renamed misc to utils.

🔧 Fixed

  • Problem importing matplotlib in docs.

  • A typo in the definition of the warning format in the logger.

  • A typo in the definition of the API exception.

View commits

1.0.0 (2018-01-31)

🚀 New

  • Initial release.

  • Includes Travis CI, Read The Docs, Coverage, and Bumpversion integrations.

  • Includes a logger and configuration library.

  • Examples for Sphinx documentation and pytest.

View commits