Sqlalchemy-mate

------------------------------------------------------------------------------
**💥Breaking Change**

- Rename ``in_process_status`` argument to ``in_progress_status``, rename ``success_status`` to ``succeeded_status``, rename ``ignore_status`` to ``ignored_status`` in :meth:`sqlalchemy_mate.patterns.status_tracker.impl.JobMixin.start`.

**Features and Improvements**

- Add ``pending_status`` and ``more_pending_status`` argument to :meth:`sqlalchemy_mate.patterns.status_tracker.impl.JobMixin.start`. Rename ``in_process_status`` argument to ``in_progress_status``, rename ``success_status`` to ``succeeded_status``, rename ``ignore_status`` to ``ignored_status``.

**Minor Improvements**

**Bugfixes**

**Miscellaneous**

------------------------------------------------------------------------------
**Features and Improvements**

- Add "Large binary column" pattern, support local file and Amazon S3 backend.
- Add the following public API
- ``sqlalchemy_mate.api.patterns.large_binary_column.aws_s3``
- ``sqlalchemy_mate.api.patterns.large_binary_column.aws_s3.PutS3BackedColumnResult``
- ``sqlalchemy_mate.api.patterns.large_binary_column.aws_s3.put_s3backed_column``
- ``sqlalchemy_mate.api.patterns.large_binary_column.aws_s3.clean_up_created_s3_object_when_create_or_update_row_failed``
- ``sqlalchemy_mate.api.patterns.large_binary_column.aws_s3.clean_up_old_s3_object_when_update_row_succeeded``
- ``sqlalchemy_mate.api.patterns.large_binary_column.aws_s3.PutS3ApiCall``
- ``sqlalchemy_mate.api.patterns.large_binary_column.aws_s3.PutS3Result``
- ``sqlalchemy_mate.api.patterns.large_binary_column.aws_s3.put_s3``
- ``sqlalchemy_mate.api.patterns.large_binary_column.local``
- ``sqlalchemy_mate.api.patterns.large_binary_column.local.WriteFileBackedColumnResult``
- ``sqlalchemy_mate.api.patterns.large_binary_column.local.write_file_backed_column``
- ``sqlalchemy_mate.api.patterns.large_binary_column.local.clean_up_new_file_when_create_or_update_row_failed``
- ``sqlalchemy_mate.api.patterns.large_binary_column.local.clean_up_old_file_when_update_row_succeeded``
- ``sqlalchemy_mate.api.patterns.large_binary_column.local.WriteFileApiCall``
- ``sqlalchemy_mate.api.patterns.large_binary_column.local.WriteFileResult``
- ``sqlalchemy_mate.api.patterns.large_binary_column.local.write_file``

**Minor Improvements**

- Use jupyter notebook to generate documentation.

------------------------------------------------------------------------------
**💥Breaking Change**

- Rework the public API import. Now you have to use ``import sqlalchemy_mate.api as sam`` to access the public API. ``from sqlalchemy_mate import ...`` is no longer working. Here's the full list of public API:
- ``sqlalchemy_mate.api.selecting.count_row``
- ``sqlalchemy_mate.api.selecting.by_pk``
- ``sqlalchemy_mate.api.selecting.select_all``
- ``sqlalchemy_mate.api.selecting.select_single_column``
- ``sqlalchemy_mate.api.selecting.select_many_column``
- ``sqlalchemy_mate.api.selecting.select_single_distinct``
- ``sqlalchemy_mate.api.selecting.select_many_distinct``
- ``sqlalchemy_mate.api.selecting.select_random``
- ``sqlalchemy_mate.api.selecting.yield_tuple``
- ``sqlalchemy_mate.api.selecting.yield_dict``
- ``sqlalchemy_mate.api.inserting.smart_insert``
- ``sqlalchemy_mate.api.updating.update_all``
- ``sqlalchemy_mate.api.updating.upsert_all``
- ``sqlalchemy_mate.api.deleting.delete_all``
- ``sqlalchemy_mate.api.test_connection``
- ``sqlalchemy_mate.api.EngineCreator``
- ``sqlalchemy_mate.api.ExtendedBase``
- ``sqlalchemy_mate.api.TimeoutError``
- ``sqlalchemy_mate.api.io.sql_to_csv``
- ``sqlalchemy_mate.api.io.table_to_csv``
- ``sqlalchemy_mate.api.pt.from_result``
- ``sqlalchemy_mate.api.pt.from_text_clause``
- ``sqlalchemy_mate.api.pt.from_stmt``
- ``sqlalchemy_mate.api.pt.from_table``
- ``sqlalchemy_mate.api.pt.from_model``
- ``sqlalchemy_mate.api.pt.from_dict_list``
- ``sqlalchemy_mate.api.pt.from_everything``
- ``sqlalchemy_mate.api.patterns.status_tracker.JobLockedError``
- ``sqlalchemy_mate.api.patterns.status_tracker.JobIgnoredError``
- ``sqlalchemy_mate.api.patterns.status_tracker.JobMixin``
- ``sqlalchemy_mate.api.patterns.status_tracker.Updates``

**Features and Improvements**

- Add status tracker pattern.

------------------------------------------------------------------------------
**💥Breaking Change**

- From ``sqlalchemy_mate>=2.0.0.0``, it only support ``sqlalchemy>=2.0.0`` and only compatible with sqlalchemy 2.X API. Everything marked as ``no longer supported`` or ``no longer accepted`` in `SQLAlchemy 2.0 - Major Migration Guide <https://docs.sqlalchemy.org/en/20/changelog/migration_20.html#migration-core-connection-transaction>`_ document will no longer be supported from this version.
- Drop Python3.7 support. Now it only support 3.8+.

**Features and Improvements**

- Fully adapt sqlalchemy 2.X API.

**Minor Improvements**

- Migrate to `cookiecutter-pyproject v4 <https://github.com/MacHu-GWU/cookiecutter-pyproject/releases/tag/v4>`_ code skeleton.

------------------------------------------------------------------------------
**Bugfixes**

- fix a syntax bug in ``requirements.txt``

------------------------------------------------------------------------------
**Features and Improvements**

- add ``sqlalchemy_mate.types.JSONSerializableType``
- add ``sqlalchemy_mate.types.CompressedStringType``
- add ``sqlalchemy_mate.types.CompressedBinaryType``
- add ``sqlalchemy_mate.ExtendedBase.select_all`` method

**Bugfixes**

- Fix the underlying implementation type for ``sqlalchemy_mate.types.CompressedJSONType``