Changelog

This is the changelog of formelsammlung. Releases and their respective changes are listed here. The order of releases is time and not version based! For a list of all available releases see the release section on Github.

5.0.0 (2021-02-06)

diff v4.0.0…v5.0.0

BREAKING CHANGES

  • change min python version from 3.6.1 to 3.6.2

New features

  • refactored getenv_typed() backend into EnvVarGetter class which holds the config

Documentation

  • improved docs for envvar.py

  • improved docs for flask_sphinx_docs.py

  • improved docs for nox_session.py

Miscellaneous

  • updated code-climate config for maintainability checks #26

  • refactored env_var_runner.py to reduce cognitive complexity and added tests for new code

  • refactored envvar.py to reduce cognitive complexity and added tests for new code

  • refactored flask_sphinx_docs.py to reduce cognitive complexity and added tests for new code

4.0.0 (2021-02-04)

diff v3.2.0…v4.0.0

BREAKING CHANGES

  • strcalc.calculate_string now raises strcalc.StringCalculatorError exceptions

New features

  • added nox_session.session_w_poetry decorator for use in noxfile.py.

  • updated root __init__.py to serve more metadata.

Bugfixes

  • fixed constructor of flask_sphinx_docs.SphinxDocServer to take the right arguments

  • fixed type hints in flask_sphinx_docs

  • fixed SphinxDocServer.web_docs‘s (view function) way of patching the app.static_folder.

Miscellaneous

  • moved CI to Github Actions

  • added Github templates

  • updated dev tools and repo structure to match my new standard

  • revised test suit

  • fixed where_installed tests for windows

  • tests now also run for PyPy3 on Linux/mac-OS and py3.10 on all 3 OS

v3.2.0 (2021-01-21)

diff v3.1.0…v3.2.0

New features

  • get_venv_tmp_dir now take a tuple of temp dir names to search (optional).

  • get_venv_tmp_dir now can create a temp dir if non is found (opt-in). The name of the temp dir can be customized.

v3.1.0 (2021-01-21)

diff 3.0.1…v3.1.0

New features

  • get_venv_tmp_dir now also finds dotted tmp directories.

Bugfixes:

  • test_exponentiation no allows 0 for first number, which caused ZeroDivisionError.

v3.0.1 (2020-12-11)

diff 3.0.0…3.0.1

Bugfixes:

  • where_installed no longer fails when no venv is active.

v3.0.0 (2020-12-07)

diff 2.0.0…3.0.0

BREAKING CHANGES

  • get_venv_path, get_venv_bin_dir, get_venv_tmp_dir and get_venv_site_packages_dir now always raise FileNotFoundError when a venv or the corresponding directory could not be found. Removed the raises_error parameter.

v2.0.0 (2020-12-07)

diff 1.2.0…2.0.0

New features

  • Added get_venv_bin_dir and get_venv_tmp_dir functions.

BREAKING CHANGES

  • get_venv_path now returns a pathlib.Path object instead of a string.

v1.2.0 (2020-11-26)

diff 1.1.0…1.2.0

New features

  • env_exe_runner now takes a list of runners which can also be a venv.

v1.1.0 (2020-11-25)

diff 1.0.0…1.1.0

New features

  • Added venv_utils module.

v1.0.0 (2020-11-21)

diff 0.4.0…1.0.0

BREAKING CHANGES

  • Renamed tox_env_exe_runner to env_exe_runner and added runner argument on 2nd place, which takes either tox or nox. With this both runner are supported.

v0.4.0 (2020-11-14)

diff 0.3.2…0.4.0

New features

  • Added tox_env_exe_runner with wrapper to call it from cli. #17

v0.3.2 (2020-11-13)

diff 0.3.1…0.3.2

Miscellaneous

  • Broaden importlib-metadata version dependency

v0.3.1 (2020-10-24)

diff 0.3.0…0.3.1

Bugfixes:

  • Put pytest-flask into testing extra, put flask into flask extra. #16

Documentation

  • Removed old “commit mentioning” passage from changelog. #15

Miscellaneous

  • Update flake8-eradicate to 1.0 in pre-commit. #6

v0.3.0 (2020-10-09)

diff 0.2.1…0.3.0

New features

  • Added auto detection for sphinx doc dir for SphinxDocServer. #14

v0.2.1 (2020-10-07)

diff 0.2.0…0.2.1

Bugfixes:

  • Removed redundant dependency python-dotenv. #12

Documentation

  • Added instruction for creating a venv to install the package into to installation docs. #13

v0.2.0 (2020-10-06)

diff 0.1.0…0.2.0

Bugfixes:

  • Fix the bugged test test_strcalc.test_exponentiation by increasing the base by one for the negative exponent tests. #5

  • Fixed CI bug with complex numbers. #7

New features

  • Added SphinxDocServer. A flask plugin which adds a route to the flask app to show your build sphinx docs. #4

Documentation

  • Added missing basic information to docs. #2

  • Added code examples to docstrings. #8

  • Increase toctree depth to 5 to show single submodules in API docs. #9

  • Added little functionality overview to README. #11