SQLAlchemy-Continuum 1.5.2__tar.gz → 1.7.0__tar.gz

{sqlalchemy_continuum-1.5.2 → sqlalchemy_continuum-1.7.0}/CHANGES.rst

@@ -5,7 +5,27 @@ Here you can see the full list of changes between each SQLAlchemy-Continuum rele
 
 Unreleased changes
 ^^^^^^^^^^^^^^^^^^
-- None currently
+- TODO
+
+1.7.0 (2026-07-02)
+^^^^^^^^^^^^^^^^^^
+- Drop Python 3.9 support (EOL October 2025); the minimum supported Python is now 3.10
+- Modernize codebase to Python 3.10+ syntax (PEP 604 unions, built-in generics, plain dicts instead of ``OrderedDict``)
+- Migrate documentation from Sphinx/reStructuredText to `Zensical <https://zensical.org>`_ (Markdown + mkdocstrings)
+- Fix broken user guide examples (``session.commit(article)``, ``sync_trigger(conn, ...)``, ``Transaction.query``, ``create_session`` removed in SQLAlchemy 2.0) and add ``tests/test_user_guide_examples.py`` to keep documented examples working
+- Remove a leftover ``breakpoint()`` call in ``TransactionChangesPlugin``
+- Fix latent ``AttributeError`` in ``VersioningManager.append_association_operation``
+- Expand ruff lint rules (E/W/F/I/B/C4/UP) and drop the separate pyupgrade pre-commit hook
+- Move test/dev/docs dependencies to PEP 735 ``[dependency-groups]``; package extras are now user-facing only (``flask``, ``flask-login``, ``flask-sqlalchemy``)
+- Publish to PyPI via GitHub Actions trusted publishing on GitHub releases
+- Add Dependabot (GitHub Actions, uv lockfile, pre-commit hooks), issue/PR templates, CONTRIBUTING.md and SECURITY.md
+
+1.6.0 (2026-01-22)
+^^^^^^^^^^^^^^^^^^
+- Add ``version_at()`` class method on version objects for efficient retrieval of the version active at a specific transaction (#376)
+- Add ``all_versions()`` class method with ``link`` option to batch fetch all versions for an entity in a single query, avoiding N+1 queries by pre-populating previous/next navigation caches (#376)
+- Add automatic composite indexes on version tables for optimized version lookups: ``(pk_columns, transaction_id DESC)`` index and ``(pk_columns, transaction_id, end_transaction_id)`` for validity strategy temporal queries (#376)
+- Add ``create_composite_index`` configuration option to control composite index creation (#376)
 
 1.5.2 (2025-10-10)
 ^^^^^^^^^^^^^^^^^^
@@ -14,6 +34,13 @@ Unreleased changes
 1.5.1 (2025-10-01)
 ^^^^^^^^^^^^^^^^^^
 - Fix utc_now() to return a naive datetime (#373, thanks to dawhalen)
+- Remove SQLAlchemy-Utils dependency by porting required functions to internal _compat module (#352)
+  Note: if you use SQLAlchemy-Utils directly, you may need to add it as a dependency.
+  - Port core functions: ImproperlyConfigured, get_declarative_base, naturally_equivalent
+  - Port column utilities: get_columns, get_primary_keys, identity, get_column_key
+  - Port advanced functionality: has_changes, JSONType, generic_relationship with full SQLAlchemy 2.x compatibility
+  - Maintain full backward compatibility while eliminating external dependency
+  - Reduce installation footprint and potential version conflicts
 
 1.5.0 (2025-08-30)
 ^^^^^^^^^^^^^^^^^^
@@ -32,13 +59,6 @@ Unreleased changes
 - Fix datetime.utcnow() deprecation warnings with cross-version compatibility function supporting Python 3.9-3.13+
 - Eliminate cartesian product warnings in many-to-many relationship queries with non-versioned classes
 - Improve code quality by modernizing mixed string formatting patterns to f-strings
-- **MAJOR**: Remove SQLAlchemy-Utils dependency by porting required functions to internal _compat module (#352)
-  
-  - Port core functions: ImproperlyConfigured, get_declarative_base, naturally_equivalent
-  - Port column utilities: get_columns, get_primary_keys, identity, get_column_key
-  - Port advanced functionality: has_changes, JSONType, generic_relationship with full SQLAlchemy 2.x compatibility
-  - Maintain full backward compatibility while eliminating external dependency
-  - Reduce installation footprint and potential version conflicts
 
 1.4.2 (2024-03-26)
 ^^^^^^^^^^^^^^^^^^

{sqlalchemy_continuum-1.5.2/SQLAlchemy_Continuum.egg-info → sqlalchemy_continuum-1.7.0}/PKG-INFO

@@ -1,17 +1,18 @@
 Metadata-Version: 2.4
 Name: SQLAlchemy-Continuum
-Version: 1.5.2
+Version: 1.7.0
 Summary: Versioning and auditing extension for SQLAlchemy.
 Author: Mark Steward, Jose Soto
 Author-email: Konsta Vesterinen <konsta@fastmonkeys.com>
 License-Expression: BSD-3-Clause
-Project-URL: Homepage, https://github.com/kvesteri/sqlalchemy-continuum
+Project-URL: Homepage, https://github.com/sqlalchemy-continuum/sqlalchemy-continuum
+Project-URL: Documentation, https://sqlalchemy-continuum.github.io/
+Project-URL: Changelog, https://github.com/sqlalchemy-continuum/sqlalchemy-continuum/blob/main/CHANGES.rst
 Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -19,31 +20,16 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: SQLAlchemy<2.1,>=1.4.53
-Provides-Extra: test
-Requires-Dist: pytest>=2.3.5; extra == "test"
-Requires-Dist: psycopg2>=2.4.6; extra == "test"
-Requires-Dist: PyMySQL>=0.8.0; extra == "test"
-Requires-Dist: Flask>=0.9; extra == "test"
-Requires-Dist: Flask-Login>=0.2.9; extra == "test"
-Requires-Dist: Flask-SQLAlchemy>=1.0; extra == "test"
-Requires-Dist: packaging; extra == "test"
 Provides-Extra: flask
-Requires-Dist: Flask>=0.9; extra == "flask"
+Requires-Dist: Flask>=2.0; extra == "flask"
 Provides-Extra: flask-login
-Requires-Dist: Flask-Login>=0.2.9; extra == "flask-login"
+Requires-Dist: Flask-Login>=0.6; extra == "flask-login"
 Provides-Extra: flask-sqlalchemy
-Requires-Dist: Flask-SQLAlchemy>=1.0; extra == "flask-sqlalchemy"
-Provides-Extra: dev
-Requires-Dist: ruff>=0.1.0; extra == "dev"
-Requires-Dist: tox>=4.0.0; extra == "dev"
-Requires-Dist: pre-commit>=3.0.0; extra == "dev"
-Provides-Extra: docs
-Requires-Dist: sphinx>=4.0.0; extra == "docs"
-Requires-Dist: furo>=2021.11.0; extra == "docs"
+Requires-Dist: Flask-SQLAlchemy>=3.0; extra == "flask-sqlalchemy"
 Dynamic: license-file
 
 SQLAlchemy-Continuum
@@ -86,6 +72,7 @@ In order to make your models versioned you need two things:
 .. code-block:: python
 
 
+    import sqlalchemy as sa
     from sqlalchemy_continuum import make_versioned
 
 
@@ -128,7 +115,7 @@ For completeness, below is a working example.
 
     from sqlalchemy_continuum import make_versioned
     from sqlalchemy import Column, Integer, Unicode, UnicodeText, create_engine
-    from sqlalchemy.orm import create_session, configure_mappers, declarative_base
+    from sqlalchemy.orm import Session, configure_mappers, declarative_base
 
     make_versioned(user_cls=None)
 
@@ -143,13 +130,13 @@ For completeness, below is a working example.
     configure_mappers()
     engine = create_engine('sqlite://')
     Base.metadata.create_all(engine)
-    session = create_session(bind=engine, autocommit=False)
+    session = Session(engine)
 
-    article = Article(name=u'Some article', content=u'Some content')
+    article = Article(name='Some article', content='Some content')
     session.add(article)
     session.commit()
     article.versions[0].name
-    article.name = u'Updated name'
+    article.name = 'Updated name'
     session.commit()
     article.versions[1].name
     article.versions[0].revert()
@@ -158,16 +145,16 @@ For completeness, below is a working example.
 Resources
 ---------
 
-- `Documentation <https://sqlalchemy-continuum.readthedocs.io/>`_
-- `Issue Tracker <http://github.com/kvesteri/sqlalchemy-continuum/issues>`_
-- `Code <http://github.com/kvesteri/sqlalchemy-continuum/>`_
+- `Documentation <https://sqlalchemy-continuum.github.io/>`_
+- `Issue Tracker <https://github.com/sqlalchemy-continuum/sqlalchemy-continuum/issues>`_
+- `Code <https://github.com/sqlalchemy-continuum/sqlalchemy-continuum>`_
 
 
 .. image:: http://i.imgur.com/UFaRx.gif
 
 
-.. |Build Status| image:: https://github.com/kvesteri/sqlalchemy-continuum/workflows/Test/badge.svg
-   :target: https://github.com/kvesteri/sqlalchemy-continuum/actions?query=workflow%3ATest
+.. |Build Status| image:: https://github.com/sqlalchemy-continuum/sqlalchemy-continuum/workflows/Test/badge.svg
+   :target: https://github.com/sqlalchemy-continuum/sqlalchemy-continuum/actions?query=workflow%3ATest
 .. |Version Status| image:: https://img.shields.io/pypi/v/SQLAlchemy-Continuum.png
    :target: https://pypi.python.org/pypi/SQLAlchemy-Continuum/
 .. |Downloads| image:: https://img.shields.io/pypi/dm/SQLAlchemy-Continuum.png

{sqlalchemy_continuum-1.5.2 → sqlalchemy_continuum-1.7.0}/README.rst

@@ -38,6 +38,7 @@ In order to make your models versioned you need two things:
 .. code-block:: python
 
 
+    import sqlalchemy as sa
     from sqlalchemy_continuum import make_versioned
 
 
@@ -80,7 +81,7 @@ For completeness, below is a working example.
 
     from sqlalchemy_continuum import make_versioned
     from sqlalchemy import Column, Integer, Unicode, UnicodeText, create_engine
-    from sqlalchemy.orm import create_session, configure_mappers, declarative_base
+    from sqlalchemy.orm import Session, configure_mappers, declarative_base
 
     make_versioned(user_cls=None)
 
@@ -95,13 +96,13 @@ For completeness, below is a working example.
     configure_mappers()
     engine = create_engine('sqlite://')
     Base.metadata.create_all(engine)
-    session = create_session(bind=engine, autocommit=False)
+    session = Session(engine)
 
-    article = Article(name=u'Some article', content=u'Some content')
+    article = Article(name='Some article', content='Some content')
     session.add(article)
     session.commit()
     article.versions[0].name
-    article.name = u'Updated name'
+    article.name = 'Updated name'
     session.commit()
     article.versions[1].name
     article.versions[0].revert()
@@ -110,16 +111,16 @@ For completeness, below is a working example.
 Resources
 ---------
 
-- `Documentation <https://sqlalchemy-continuum.readthedocs.io/>`_
-- `Issue Tracker <http://github.com/kvesteri/sqlalchemy-continuum/issues>`_
-- `Code <http://github.com/kvesteri/sqlalchemy-continuum/>`_
+- `Documentation <https://sqlalchemy-continuum.github.io/>`_
+- `Issue Tracker <https://github.com/sqlalchemy-continuum/sqlalchemy-continuum/issues>`_
+- `Code <https://github.com/sqlalchemy-continuum/sqlalchemy-continuum>`_
 
 
 .. image:: http://i.imgur.com/UFaRx.gif
 
 
-.. |Build Status| image:: https://github.com/kvesteri/sqlalchemy-continuum/workflows/Test/badge.svg
-   :target: https://github.com/kvesteri/sqlalchemy-continuum/actions?query=workflow%3ATest
+.. |Build Status| image:: https://github.com/sqlalchemy-continuum/sqlalchemy-continuum/workflows/Test/badge.svg
+   :target: https://github.com/sqlalchemy-continuum/sqlalchemy-continuum/actions?query=workflow%3ATest
 .. |Version Status| image:: https://img.shields.io/pypi/v/SQLAlchemy-Continuum.png
    :target: https://pypi.python.org/pypi/SQLAlchemy-Continuum/
 .. |Downloads| image:: https://img.shields.io/pypi/dm/SQLAlchemy-Continuum.png

{sqlalchemy_continuum-1.5.2 → sqlalchemy_continuum-1.7.0/SQLAlchemy_Continuum.egg-info}/PKG-INFO

@@ -1,17 +1,18 @@
 Metadata-Version: 2.4
 Name: SQLAlchemy-Continuum
-Version: 1.5.2
+Version: 1.7.0
 Summary: Versioning and auditing extension for SQLAlchemy.
 Author: Mark Steward, Jose Soto
 Author-email: Konsta Vesterinen <konsta@fastmonkeys.com>
 License-Expression: BSD-3-Clause
-Project-URL: Homepage, https://github.com/kvesteri/sqlalchemy-continuum
+Project-URL: Homepage, https://github.com/sqlalchemy-continuum/sqlalchemy-continuum
+Project-URL: Documentation, https://sqlalchemy-continuum.github.io/
+Project-URL: Changelog, https://github.com/sqlalchemy-continuum/sqlalchemy-continuum/blob/main/CHANGES.rst
 Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -19,31 +20,16 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: SQLAlchemy<2.1,>=1.4.53
-Provides-Extra: test
-Requires-Dist: pytest>=2.3.5; extra == "test"
-Requires-Dist: psycopg2>=2.4.6; extra == "test"
-Requires-Dist: PyMySQL>=0.8.0; extra == "test"
-Requires-Dist: Flask>=0.9; extra == "test"
-Requires-Dist: Flask-Login>=0.2.9; extra == "test"
-Requires-Dist: Flask-SQLAlchemy>=1.0; extra == "test"
-Requires-Dist: packaging; extra == "test"
 Provides-Extra: flask
-Requires-Dist: Flask>=0.9; extra == "flask"
+Requires-Dist: Flask>=2.0; extra == "flask"
 Provides-Extra: flask-login
-Requires-Dist: Flask-Login>=0.2.9; extra == "flask-login"
+Requires-Dist: Flask-Login>=0.6; extra == "flask-login"
 Provides-Extra: flask-sqlalchemy
-Requires-Dist: Flask-SQLAlchemy>=1.0; extra == "flask-sqlalchemy"
-Provides-Extra: dev
-Requires-Dist: ruff>=0.1.0; extra == "dev"
-Requires-Dist: tox>=4.0.0; extra == "dev"
-Requires-Dist: pre-commit>=3.0.0; extra == "dev"
-Provides-Extra: docs
-Requires-Dist: sphinx>=4.0.0; extra == "docs"
-Requires-Dist: furo>=2021.11.0; extra == "docs"
+Requires-Dist: Flask-SQLAlchemy>=3.0; extra == "flask-sqlalchemy"
 Dynamic: license-file
 
 SQLAlchemy-Continuum
@@ -86,6 +72,7 @@ In order to make your models versioned you need two things:
 .. code-block:: python
 
 
+    import sqlalchemy as sa
     from sqlalchemy_continuum import make_versioned
 
 
@@ -128,7 +115,7 @@ For completeness, below is a working example.
 
     from sqlalchemy_continuum import make_versioned
     from sqlalchemy import Column, Integer, Unicode, UnicodeText, create_engine
-    from sqlalchemy.orm import create_session, configure_mappers, declarative_base
+    from sqlalchemy.orm import Session, configure_mappers, declarative_base
 
     make_versioned(user_cls=None)
 
@@ -143,13 +130,13 @@ For completeness, below is a working example.
     configure_mappers()
     engine = create_engine('sqlite://')
     Base.metadata.create_all(engine)
-    session = create_session(bind=engine, autocommit=False)
+    session = Session(engine)
 
-    article = Article(name=u'Some article', content=u'Some content')
+    article = Article(name='Some article', content='Some content')
     session.add(article)
     session.commit()
     article.versions[0].name
-    article.name = u'Updated name'
+    article.name = 'Updated name'
     session.commit()
     article.versions[1].name
     article.versions[0].revert()
@@ -158,16 +145,16 @@ For completeness, below is a working example.
 Resources
 ---------
 
-- `Documentation <https://sqlalchemy-continuum.readthedocs.io/>`_
-- `Issue Tracker <http://github.com/kvesteri/sqlalchemy-continuum/issues>`_
-- `Code <http://github.com/kvesteri/sqlalchemy-continuum/>`_
+- `Documentation <https://sqlalchemy-continuum.github.io/>`_
+- `Issue Tracker <https://github.com/sqlalchemy-continuum/sqlalchemy-continuum/issues>`_
+- `Code <https://github.com/sqlalchemy-continuum/sqlalchemy-continuum>`_
 
 
 .. image:: http://i.imgur.com/UFaRx.gif
 
 
-.. |Build Status| image:: https://github.com/kvesteri/sqlalchemy-continuum/workflows/Test/badge.svg
-   :target: https://github.com/kvesteri/sqlalchemy-continuum/actions?query=workflow%3ATest
+.. |Build Status| image:: https://github.com/sqlalchemy-continuum/sqlalchemy-continuum/workflows/Test/badge.svg
+   :target: https://github.com/sqlalchemy-continuum/sqlalchemy-continuum/actions?query=workflow%3ATest
 .. |Version Status| image:: https://img.shields.io/pypi/v/SQLAlchemy-Continuum.png
    :target: https://pypi.python.org/pypi/SQLAlchemy-Continuum/
 .. |Downloads| image:: https://img.shields.io/pypi/dm/SQLAlchemy-Continuum.png

{sqlalchemy_continuum-1.5.2 → sqlalchemy_continuum-1.7.0}/SQLAlchemy_Continuum.egg-info/SOURCES.txt

@@ -8,23 +8,21 @@ SQLAlchemy_Continuum.egg-info/SOURCES.txt
 SQLAlchemy_Continuum.egg-info/dependency_links.txt
 SQLAlchemy_Continuum.egg-info/requires.txt
 SQLAlchemy_Continuum.egg-info/top_level.txt
-docs/Makefile
-docs/alembic.rst
-docs/api.rst
-docs/conf.py
-docs/configuration.rst
-docs/index.rst
-docs/intro.rst
-docs/license.rst
-docs/make.bat
-docs/native_versioning.rst
-docs/plugins.rst
-docs/queries.rst
-docs/revert.rst
-docs/schema.rst
-docs/transactions.rst
-docs/utilities.rst
-docs/version_objects.rst
+docs/alembic.md
+docs/api.md
+docs/changelog.md
+docs/configuration.md
+docs/index.md
+docs/intro.md
+docs/license.md
+docs/native_versioning.md
+docs/plugins.md
+docs/queries.md
+docs/revert.md
+docs/schema.md
+docs/transactions.md
+docs/utilities.md
+docs/version_objects.md
 sqlalchemy_continuum/__init__.py
 sqlalchemy_continuum/_compat.py
 sqlalchemy_continuum/builder.py
@@ -64,6 +62,7 @@ tests/test_configuration.py
 tests/test_custom_schema.py
 tests/test_custom_version_base_class.py
 tests/test_delete.py
+tests/test_efficient_queries.py
 tests/test_exotic_listener_chaining.py
 tests/test_exotic_operation_combos.py
 tests/test_insert.py
@@ -74,6 +73,7 @@ tests/test_savepoints.py
 tests/test_sessions.py
 tests/test_transaction.py
 tests/test_update.py
+tests/test_user_guide_examples.py
 tests/test_vacuum.py
 tests/test_validity_strategy.py
 tests/test_validity_strategy_multithreaded.py

sqlalchemy_continuum-1.7.0/SQLAlchemy_Continuum.egg-info/requires.txt

@@ -0,0 +1,10 @@
+SQLAlchemy<2.1,>=1.4.53
+
+[flask]
+Flask>=2.0
+
+[flask-login]
+Flask-Login>=0.6
+
+[flask-sqlalchemy]
+Flask-SQLAlchemy>=3.0

sqlalchemy_continuum-1.5.2/docs/alembic.rst → sqlalchemy_continuum-1.7.0/docs/alembic.md

@@ -1,11 +1,9 @@
-Alembic migrations
-==================
+# Alembic migrations
 
 Each time you make changes to database structure you should also change the associated history tables. When you make changes to your models SQLAlchemy-Continuum automatically alters the history model definitions, hence you can use `alembic revision --autogenerate` just like before. You just need to make sure `make_versioned` function gets called before alembic gathers all your models and `configure_mappers` is called afterwards.
 
 Pay close attention when dropping or moving data from parent tables and reflecting these changes to history tables.
 
-Troubleshooting
-###############
+## Troubleshooting
 
 If alembic didn't detect any changes or generates reversed migration (tries to remove `*_version` tables from database instead of creating), make sure that `configure_mappers` was called by alembic command.

sqlalchemy_continuum-1.7.0/docs/api.md

@@ -0,0 +1,27 @@
+# API reference
+
+::: sqlalchemy_continuum.make_versioned
+
+## Versioning Manager
+
+::: sqlalchemy_continuum.manager.VersioningManager
+
+## Builders
+
+::: sqlalchemy_continuum.table_builder.TableBuilder
+
+::: sqlalchemy_continuum.model_builder.ModelBuilder
+
+::: sqlalchemy_continuum.relationship_builder.RelationshipBuilder
+
+## UnitOfWork
+
+::: sqlalchemy_continuum.unit_of_work.UnitOfWork
+
+## History class
+
+::: sqlalchemy_continuum.version.VersionClassBase
+
+## Changelog
+
+See the [changelog](changelog.md) for a full list of changes in each release.