Change Log¶
This document records the main changes to the python-template code.
2.1.0 (2021-03-24)¶
Added¶
- GitHub workflow for testing.
Changed¶
- Updated dependencies.
- Removed the requirements
docs
extra. Instead, documentation extra packages are defined in arequirements.txt
indocs/sphinx
and automatically installed in the RTD build.
2.0.0 (2020-04-13)¶
Changed¶
- Dropped support for Python 2.
- Move style guide to root level.
- Use
setup.cfg
for packaging and configuration ofpytest
,flake8
,isort
, andcoverage
. - Move
tests
outside of the package to simplify packaging. - Replace
utils
with sdsstools. - Remove use of
bumpversion
. Instead, get the package version usingsdsstools.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
andalabaster
.
1.0.6 (2019-12-31)¶
Added¶
- 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.
1.0.5 (2019-05-13)¶
Backward incompatible changes¶
- The default path for the user configuration file is now
~/.config/<name>/<name>.yml
.
Added¶
- 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.
Fixed¶
- Bug causing Python 2.7 templates to fail because
PercentStyle
is not available inlogging
module (thanks to @andycasey).
1.0.3 (2018-12-10)¶
1.0.2 (2018-10-01)¶
1.0.1 (2018-07-30)¶
Added¶
- Added W0621 to disabled list in pylint.
Changed¶
- 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
toutils
.
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.