CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog.

[0.2.5] - 2021-04-06

Security

• Fixed security alert for urllib3.
• Updated requests.

[0.2.4] - 2021-03-21

Changed

• In image.py, Section.get_instructions() was replaced with the more Pythonic direct access (i.e. Section.instructions).

[0.2.3] - 2021-03-19

Security

• Fixed security alerts for urllib3 and jinja2, automated from GitHub.

[0.2.2] - 2021-03-18

Security

• Fixed security alert regarding Pillow. Pillow has been bumped to the latest version, 8.1.2.

[0.2.1] - 2021-02-06

Added

• Added more details in the readme.

Fixed

• Fixed accidental deletion of real life example image.

[0.2.0] - 2021-02-02

Changed

• In image.py:
  • DashImg is now DashImage.
  • Issue #3, continued: Individual image sections from DashImage are now their own classes, subclassing Section.
    • All sections, now and future, must be decorated with @dataclass.
    • Each section must accept y as its first argument and must also override __post_init__() and call super().__post_init__() on its first line, to ensure the attribute instructions will be created.
    • Each section's __post_init__() should contain code that builds rendering instructions for the main DashImage class.
    • As a result of this refactor, all of the non-argument attributes for DashImage are now placed module-level for access to all other classes.
    • SectionGauge methods no longer have redundant _gauge_ in their names.
    • SectionGauge.does_value_collide() no longer accepts value as an argument, as it strictly used SectionGauge.value. This change will not be applied to SectionGauge.offset(), even though one of its calls uses the same attribute, because its other calls use function-local variables.

[0.1.8] - 2021-01-22

Changed

• In image.py:
  • Renamed DashImg.gauge_text_collision() to DashImg.does_gauge_text_collide() and DashImg.gauge_value_text_collision() to DashImg.does_gauge_value_collide().
  • Changed val to value in DashImg.does_gauge_text_collide() and DashImg.does_gauge_value_collide().

Fixed

• Fixed #3: fixed gauge rendering issues that came as a result of the mypy refactor.
  • Both self.last_gauge_value and self.last_gauge_offset attributes for DashImg in image.py are now deleted in DashImg.create_gauge(), to restore similar behavior prior to the mypy refactor.
• Fixed (missing) documentation in image.py.

[0.1.7] - 2021-01-02

Changed

• The project has now been linted additionally by mypy on top of Flake8.
  • As a result, several functions had their type-hints and/or return values corrected.
  • SECTIONS in image.py was incorrectly typed and now should accurately represent the list of sections allowed.
  • T_FONT in image.py could not be used as an alias and was dropped entirely.
  • If QUIET_HOURS couldn't be set up in config.py, then rather than set it to None, the variable isn't set altogether. An AttributeError should be caught where quiet hours are used: both in app.py and utils.py.

[0.1.6] - 2020-12-10

Changed

• When sending a JSON to the endpoint, the module name no longer needs to include photo-dash- at the beginning. If the prefix is missing, it will be automatically added to the module name.

[0.1.5] - 2020-11-11

Changed

• Improved docs

[0.1.4] - 2020-11-04

Changed

• In reference of issue #1:
  • Added optional fields "quiet_start" and "quiet_end" in config.json.example. These should be integers to represent when quiet hours will begin or end.
  • Added another endpoint /quiet that will return quiet hours with a GET request.
  • During quiet hours, a special image will be generated that indicates images may not be up-to-date. This image will be deleted when quiet hours are over.

Fixed

• Status codes for put() in the API were returned incorrectly.

[0.1.3] - 2020-10-25

Changed

• get_number_half_width() in image.py should now accept float instead of strictly int.

[0.1.2] - 2020-10-25

Fixed

• The timestamp is now initialized when DashImg.create() is called.
• The photo frame is somehow scaling images past their intended borders. This has caused text to go offscreen. Now, text elements (including the footer) will have a small offset. Both title and footer will have a small spacer from the top and bottom. All text elements will have a small spacer from the nearest side.
• Gauge values (marks) should no longer obscure each other. In the case that a number might collide or intersect with a previous number, it will be skipped.
• Following on that, the value for a gauge should also not obscure its closest rendered values (on both sides).

[0.1.1] - 2020-10-25

Changed

• In the API, "data" was changed to "sections" to conform with the existing file.

[0.1.0] - 2020-10-25

Added

• Initial version