Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare for release 0.2.0 #141

Merged
merged 2 commits into from
Sep 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/_static/switcher.json
Original file line number Diff line number Diff line change
@@ -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/"
}
]
48 changes: 46 additions & 2 deletions docs/release_notes.rst
Original file line number Diff line number Diff line change
@@ -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 <cli>` page in the documentation.
* Provided a :doc:`custom dataset creation tutorial <custom_datasets>` 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
<https://medium.com/@stefaniemolin/data-morph-moving-beyond-the-datasaurus-dozen-156927b20f8c>`_
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)
---------------------

Expand All @@ -12,12 +56,12 @@ 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.
* Fun new starter datasets: cat, dog, music, panda, and sheep. See the :class:`.DataLoader` documentation for visuals.
* 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.
2 changes: 1 addition & 1 deletion src/data_morph/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@
<https://medium.com/@stefaniemolin/data-morph-moving-beyond-the-datasaurus-dozen-156927b20f8c>`_.
"""

__version__ = '0.2.0.dev0'
__version__ = '0.2.0'
MAIN_DIR = __name__