diff --git a/CHANGES.txt b/CHANGES.rst similarity index 96% rename from CHANGES.txt rename to CHANGES.rst index bbfdd997..8d71af19 100644 --- a/CHANGES.txt +++ b/CHANGES.rst @@ -5,13 +5,13 @@ Changes for crate Unreleased ========== -- The SQLAlchemy dialect has been split off into the `sqlalchemy-cratedb`_ - package. See `Migrate from crate.client to sqlalchemy-cratedb`_ to learn - about necessary migration steps. -- Returned Python ``datetime`` objects are now always timezone-aware, - using UTC by default. This is a possible BREAKING CHANGE: Removed the use - of "naive" Python ``datetime`` objects, i.e. instances without ``tzinfo`` - attribute set. +- BREAKING CHANGE: The SQLAlchemy dialect has been split off into + the `sqlalchemy-cratedb`_ package, see notice below. +- Feature: Returned Python ``datetime`` objects are now always timezone-aware, + using UTC by default. + It may be a breaking change for some users of the library that don't expect + to receive "aware" instead of "naive" Python ``datetime`` objects from now + on, i.e. instances with or without the ``tzinfo`` attribute set. When no ``time_zone`` information is specified when creating a database connection or cursor, ``datetime`` objects will now use Coordinated Universal Time (UTC), like CrateDB is storing timestamp values in this @@ -19,13 +19,11 @@ Unreleased This update is coming from a deprecation of Python's ``datetime.utcfromtimestamp()``, which is effectively also phasing out the use of "naive" timestamp objects in Python, in favor of using - timezone-aware objects, also to represent datetimes in UTC. It may be a - breaking change for some users of the library that don't expect to - receive "aware" ``datetime`` objects from now on. -- Configured DB API interface attribute ``threadsafety = 1``, which signals - "Threads may share the module, but not connections." -- Added ``error_trace`` to string representation of an Error to relay - server stacktraces into exception messages. + timezone-aware objects, also to represent datetimes in UTC. +- Feature: Configured DB API interface attribute ``threadsafety = 1``, + which signals "Threads may share the module, but not connections." +- Feature: Added ``error_trace`` to string representation of an Error, + to relay server stacktraces into exception messages. - Refactoring: The module namespace ``crate.client.test_util`` has been renamed to ``crate.testing.util``. - Error handling: At two spots in cursor / value converter handling, where @@ -35,6 +33,13 @@ Unreleased namespaces" for the ``crate`` namespace package, see `PEP 420`_. +.. note:: + + For learning about the transition to `sqlalchemy-cratedb`_, + we recommend to read the enumeration of necessary migration steps + at `Migrate from crate.client to sqlalchemy-cratedb`_. + + .. _Migrate from crate.client to sqlalchemy-cratedb: https://cratedb.com/docs/sqlalchemy-cratedb/migrate-from-crate-client.html .. _PEP 420: https://peps.python.org/pep-0420/ .. _sqlalchemy-cratedb: https://pypi.org/project/sqlalchemy-cratedb/ diff --git a/DEVELOP.rst b/DEVELOP.rst index 4d33e418..3ca00bc3 100644 --- a/DEVELOP.rst +++ b/DEVELOP.rst @@ -121,7 +121,7 @@ In the release branch: - Update ``__version__`` in ``src/crate/client/__init__.py`` -- Add a section for the new version in the ``CHANGES.txt`` file +- Add a section for the new version in the ``CHANGES.rst`` file - Commit your changes with a message like "prepare release x.y.z" diff --git a/devtools/create_tag.sh b/devtools/create_tag.sh index 1ee0f68d..e75031d9 100755 --- a/devtools/create_tag.sh +++ b/devtools/create_tag.sh @@ -58,11 +58,11 @@ then exit -1 fi -# check if VERSION is in head of CHANGES.txt -REV_NOTE=`grep "[0-9/]\{10\} $VERSION" CHANGES.txt` +# check if VERSION is in head of CHANGES.rst +REV_NOTE=`grep "[0-9/]\{10\} $VERSION" CHANGES.rst` if [ -z "$REV_NOTE" ] then - echo "No notes for revision $VERSION found in CHANGES.txt" + echo "No notes for revision $VERSION found in CHANGES.rst" echo "Aborting." exit -1 fi