From 77f0e29caf41d37284cc6a2dfdda64be54baf0cf Mon Sep 17 00:00:00 2001 From: Stefanie Molin <24376333+stefmolin@users.noreply.github.com> Date: Sun, 24 Sep 2023 00:04:10 +0100 Subject: [PATCH 1/2] Release 0.2.0 --- docs/release_notes.rst | 48 ++++++++++++++++++++++++++++++++++++-- src/data_morph/__init__.py | 2 +- 2 files changed, 47 insertions(+), 3 deletions(-) diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 6ba6f4fc..5c30c06d 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -1,6 +1,50 @@ Release Notes ============= +0.2.0 (September 24, 2023) +-------------------------- + +What's New +^^^^^^^^^^ +* Created 5 new target shapes: :class:`.Diamond`, :class:`.Heart`, + :class:`.LeftParabola`, :class:`.RightParabola`, :class:`.Rings`. +* Created 3 new datasets: bunny, Python logo (TM), SuperDataScience logo. + Logos are used with permission. +* Made it possible to install via ``conda``. +* Configured versioned documentation hosted in GitHub Pages. +* Generated a :doc:`CLI reference ` page in the documentation. +* Provided a :doc:`custom dataset creation tutorial ` to the documentation. +* Included logo and badges in README. +* Included an example using easing for the animation to the documentation. +* Included reference to `blog post on the creation of Data Morph + `_ + in the documentation. +* Configured codecov reporting on test coverage with actions to validate the + config both periodically and upon change. +* Incorporated metavar indicators for some CLI options. +* Added a test of the frame freezing functionality in the :class:`.DataMorpher`. +* Added a test for the :meth:`.ShapeFactory.plot_available_shapes` method used in the documentation. +* Added a test for the :meth:`.PointCollection.plot` method used in the documentation. + +Bug Fixes +^^^^^^^^^ +* Fixed links to Autodesk assets after change to their website. +* Corrected missing type references in the documentation. +* Addressed a bug in the :class:`.DataMorpher` that caused frame recording to miss first frame (initial dataset). +* Fixed a bug in the :class:`.DataMorpher` that wasn't properly decreasing + the temperature in the simulated annealing process. +* Reduced point size for datasets displayed in the documentation so points + appear with some separation and stay true to their subjects. +* Fixed bug in logic for padding statistics in plots that would use incorrect spacing in some cases. + +Dependency Updates +^^^^^^^^^^^^^^^^^^ +* Changed the minimum Sphinx version to 7.2.1. +* Changed the minimum ``pytweening`` version to 1.0.5. +* Switched from ``isort`` and ``flake8`` to ``ruff`` in pre-commit setup. +* Updated pre-commit hooks to the latest versions and to use the new upstream ``numpydoc`` validation hook. + + 0.1.0 (April 1, 2023) --------------------- @@ -12,7 +56,7 @@ The core improvements include: * Created a modular package, moving away from functional programming to object-oriented programming. * Introduction of :class:`.Shape` classes both for resuability of the code and to decouple the shapes from - the original "dinosaurus" dataset and its hardcoded values. Morphing is now possible from any input dataset + the original "datasaurus" dataset and its hardcoded values. Morphing is now possible from any input dataset to the target shapes. See the :class:`.ShapeFactory` documentation for visuals. * Creation of :class:`.Dataset` to hold the data along with bounds needed for morphing and plotting and the name. * Morph and plot bounding logic for automatic calculation of values needed for simulated annealing and plot limits. @@ -20,4 +64,4 @@ The core improvements include: * Easier application of plotting theme. * Documentation with Sphinx. * Testing suite with pytest. -* Replaced center shape with scatter and included a new rectangle shape. +* Replaced center shape with :class:`.Scatter` and included a new :class:`.Rectangle` shape. diff --git a/src/data_morph/__init__.py b/src/data_morph/__init__.py index 0717a7a2..ae3d2cbd 100644 --- a/src/data_morph/__init__.py +++ b/src/data_morph/__init__.py @@ -24,5 +24,5 @@ `_. """ -__version__ = '0.2.0.dev0' +__version__ = '0.2.0' MAIN_DIR = __name__ From e74e1aaa9e7977ed9f44d83513d669780d747fc7 Mon Sep 17 00:00:00 2001 From: Stefanie Molin <24376333+stefmolin@users.noreply.github.com> Date: Sun, 24 Sep 2023 17:37:22 +0100 Subject: [PATCH 2/2] Update version switcher. --- docs/_static/switcher.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/_static/switcher.json b/docs/_static/switcher.json index 7e46aeeb..3813bcd0 100644 --- a/docs/_static/switcher.json +++ b/docs/_static/switcher.json @@ -1,12 +1,12 @@ [ { - "name": "0.1 (stable)", - "version": "stable", - "url": "https://stefmolin.github.io/data-morph/stable/" + "name": "0.1", + "version": "0.1", + "url": "https://stefmolin.github.io/data-morph/0.1/" }, { - "name": "0.2 (dev)", - "version": "dev", - "url": "https://stefmolin.github.io/data-morph/dev/" + "name": "0.2 (stable)", + "version": "stable", + "url": "https://stefmolin.github.io/data-morph/stable/" } ]