Merge pull request #900 from neo4j-contrib/rc/6.0.0

Version 6.0.0 2025-11
* Modernize config object, using a dataclass with typing, runtime and update validation rules, and environment variables support
* Fix async support of parallel transactions, using ContextVar
* Introduces merge_by parameter for batch operations to customize merge behaviour (label and property keys)
* Adds rel_props to batch methods, to create relationship with properties during batch operations. Thanks to @ADernild
* Enforce strict cardinality check by default
* Refactor internal code: core.py file is now split into smaller files for database, node, transaction
* Fix object resolution for maps and lists Cypher objects, even when nested. This changes the way you can access lists in your Cypher results, see documentation for more info
* Make AsyncDatabase / Database a true singleton for clarity
* Remove deprecated methods (including fetch_relations & traverse_relations, replaced with traverse ; database operations like clear_neo4j_database or change_neo4j_password have been moved to db/adb singleton internal methods)
* Housekeeping and bug fixes

Author: mariusconjeaud

.github/workflows/integration-tests.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.13", "3.12", "3.11", "3.10", "3.9"]
+        python-version: ["3.13", "3.12", "3.11", "3.10"]
         neo4j-version: ["community", "enterprise", "5.5-enterprise", "4.4-enterprise", "4.4-community"]
 
     steps:

.gitignore

@@ -23,3 +23,4 @@ coverage_report/
 .coverage*
 .DS_STORE
 cov.xml
+test/data/model_diagram.*

.pre-commit-config.yaml

@@ -4,10 +4,12 @@ repos:
     hooks:
       - id: isort
         args: ["--profile", "black"]
+        files: ^(neomodel|test)
   - repo: https://github.com/psf/black
     rev: 23.3.0
     hooks:
       - id: black
+        files: ^(neomodel|test)
   - repo: local
     hooks:
       - id: unasync

.sonarcloud.properties

@@ -1,3 +1,6 @@
 sonar.sources = neomodel/
 sonar.tests = test/
-sonar.python.version = 3.9, 3.10, 3.11, 3.12, 3.13
+sonar.python.version = 3.10, 3.11, 3.12, 3.13
+sonar.issue.ignore.multicriteria=e1
+sonar.issue.ignore.multicriteria.e1.ruleKey=python:S100
+sonar.issue.ignore.multicriteria.e1.resourceKey=**/neomodel/config.py

Changelog

@@ -1,3 +1,15 @@
+Version 6.0.0 2025-xx
+* Modernize config object, using a dataclass with typing, runtime and update validation rules, and environment variables support
+* Fix async support of parallel transactions, using ContextVar
+* Introduces merge_by parameter for batch operations to customize merge behaviour (label and property keys)
+* Adds rel_props to batch methods, to create relationship with properties during batch operations. Thanks to @ADernild
+* Enforce strict cardinality check by default
+* Refactor internal code: core.py file is now split into smaller files for database, node, transaction
+* Fix object resolution for maps and lists Cypher objects, even when nested. This changes the way you can access lists in your Cypher results, see documentation for more info
+* Make AsyncDatabase / Database a true singleton for clarity
+* Remove deprecated methods (including fetch_relations & traverse_relations, replaced with traverse ; database operations like clear_neo4j_database or change_neo4j_password have been moved to db/adb singleton internal methods)
+* Housekeeping and bug fixes
+  
 Version 5.5.3 2025-09
 * Fix duplicated code issue in the advanced querying methods
 * Remove py.typed - this was a premature change, we should write stubs for full typing support first

README.md

@@ -22,6 +22,12 @@ GitHub repo found at <https://github.com/neo4j-contrib/neomodel/>.
 
 # Requirements
 
+**For neomodel releases 6.x :**
+
+- Python 3.10+
+- Neo4j 2025.x.x, 5.x, 4.4 (LTS)
+- Neo4j Enterprise, Community and Aura are supported
+
 **For neomodel releases 5.x :**
 
 -   Python 3.8+
@@ -37,27 +43,19 @@ GitHub repo found at <https://github.com/neo4j-contrib/neomodel/>.
 Available on
 [readthedocs](http://neomodel.readthedocs.org).
 
-# New in 5.4.0
-
-This version adds many new features, expanding neomodel's querying capabilities. Those features were kindly contributed back by the [OpenStudyBuilder team](https://openstudybuilder.com/). A VERY special thanks to [@tonioo](https://github.com/tonioo) for the integration work.
-
-There are too many new capabilities here, so I advise you to start by looking at the full summary example in the [Getting Started guide](https://neomodel.readthedocs.io/en/latest/getting_started.html#full-example). It will then point you to the various relevant sections.
+# New in 6.0.0
 
-We also validated support for [Python 3.13](https://docs.python.org/3/whatsnew/3.13.html).
+From now on, neomodel will use **SemVer (major.minor.patch)** for versioning.
 
-# New in 5.3.0
+This version introduces a modern configuration system, using a dataclass with typing, runtime and update validation rules, and environment variables support.
+See the [documentation](https://neomodel.readthedocs.io/en/latest/configuration.html) section for more details.
 
-neomodel now supports asynchronous programming, thanks to the [Neo4j driver async API](https://neo4j.com/docs/api/python-driver/current/async_api.html). The [documentation](http://neomodel.readthedocs.org) has been updated accordingly, with an updated getting started section, and some specific documentation for the async API.
+[Semantic Indexes](https://neomodel.readthedocs.io/en/latest/semantic_indexes.html#) (Vector and Full-text) are now natively supported so you do not have to use a custom Cypher query. Special thanks to @greengori11a for this.
 
-# Breaking changes in 5.3.0
+### Breaking changes
 
-- config.AUTO_INSTALL_LABELS has been removed. Please use the `neomodel_install_labels` script instead. _Note : this is because of the addition of async, but also because it might lead to uncontrolled creation of indexes/constraints. The script makes you more in control of said creation._
-- The Database class has been moved into neomodel.sync_.core - and a new AsyncDatabase introduced into neomodel.async_.core
-- Based on Python version [status](https://devguide.python.org/versions/),
-neomodel will be dropping support for Python 3.7 in an upcoming release
-(5.3 or later). _This does not mean neomodel will stop working on Python 3.7, but
-it will no longer be tested against it_
-- Some standalone methods have been refactored into the Database() class. Check the [documentation](http://neomodel.readthedocs.org) for a full list.
+* List object resolution from Cypher was creating "2-depth" lists for no apparent reason. This release fixes this so that, for example "RETURN collect(node)" will return the nodes directly as a list in the result. In other words, you can extract this list at `results[0][0]` instead of `results[0][0][0]`
+* See more breaking changes in the [documentation](http://neomodel.readthedocs.org)
 
 # Installation
 
@@ -84,7 +82,7 @@ You can find some performance tests made using Locust [in this repo](https://git
 Two learnings from this :
 
 * The wrapping of the driver made by neomodel is very thin performance-wise : it does not add a lot of overhead ;
-* When used in a concurrent fashion, async neomodel is faster than concurrent sync neomodel, and a lot of faster than serial queries.
+* When used in a concurrent fashion, async neomodel is faster than concurrent sync neomodel, and a lot faster than serial queries.
 
 # Contributing