.. _changes:

=========
Changelog
=========

You can find the changelog on the `GitHub Release page <https://github.com/bo4e/BO4E-python/releases>`_.

=============
Compatibility
=============

The table below shows the compatibility matrix of the last BO4E versions.
You can also download the compatibility matrix as CSV file `here <_static/tables/compatibility_matrix.csv>`__.

.. csv-table:: Diff-files for the version diffs shown in the compatibility matrix
   :file: _static/tables/changes_table.csv
   :header-rows: 1

.. table:: Legend for compatibility matrix
   :widths: 10 90

   +------+---------------------------------------------------------------------------------------------------+
   | Icon | Description                                                                                       |
   +======+===================================================================================================+
   | 🟢   | | :main-color:`Compatible`                                                                        |
   |      | | No changes in the data model                                                                    |
   +------+---------------------------------------------------------------------------------------------------+
   | 🟡   | | :main-color:`Compatible`                                                                        |
   |      | | Only non\-critical changes in the data model e.g. added fields, changed doc strings             |
   +------+---------------------------------------------------------------------------------------------------+
   | 🔴   | | :error-color:`Incompatible`                                                                     |
   |      | | Critical changes in the data model e.g. removed fields, changed types                           |
   +------+---------------------------------------------------------------------------------------------------+
   | ➕   | | :main-color:`Compatible`                                                                        |
   |      | | Data model was added in this version                                                            |
   +------+---------------------------------------------------------------------------------------------------+
   | ➖   | | :error-color:`Incompatible`                                                                     |
   |      | | Data model was removed in this version                                                          |
   +------+---------------------------------------------------------------------------------------------------+
   | \-   | | Non\-existent                                                                                   |
   |      | | Doesn't exist in this version i.e. it was removed before or will be added in future             |
   +------+---------------------------------------------------------------------------------------------------+

.. csv-table:: Compatibility matrix
   :file: _static/tables/compatibility_matrix.csv
   :header-rows: 1