pyneoinstance 4.0.0__tar.gz → 4.0.2__tar.gz

{pyneoinstance-4.0.0/pyneoinstance.egg-info → pyneoinstance-4.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyneoinstance
-Version: 4.0.0
+Version: 4.0.2
 Summary: Handle Neo4j read and write transactions and provide methods for performing graph EDA
 Author-email: "Jose A. Alvarado-Guzman" <jose.alvarado-guzman@neo4j.com>
 License: GNU GENERAL PUBLIC LICENSE
@@ -694,9 +694,10 @@ Requires-Dist: neo4j-rust-ext>=5.0.0
 Requires-Dist: pandas>=1.3.0
 Requires-Dist: PyYAML>=5.1
 Requires-Dist: pyvis>=0.3.0
-Requires-Dist: neo4j-viz>=0.5.0
+Requires-Dist: neo4j-viz>=1.0.0
 Provides-Extra: docs
 Requires-Dist: mkdocs-material>=9.0.0; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24.0; extra == "docs"
 Dynamic: license-file
 
 # PyNeoInstance Package
@@ -794,7 +795,7 @@ This YAML file can then be loaded in Python and this information can be retrieve
 ```python
 from pyneoinstance import load_yaml_file
 
-config = load_yaml_file(configuration.yaml)
+config = load_yaml_file('configuration.yaml')
 db_info = config['db_info']
 graph = Neo4jInstance(db_info['uri'], db_info['user'], db_info['password'])
 ```
@@ -1037,5 +1038,6 @@ Open `schema.html` in your browser to explore the schema interactively.
 ## More detailed examples
 
 For more detailed examples please refer to the following articles:
-* Data ingestion: [PyNeoInstance: A User-Friendly Python Library for Neo4j](https://medium.com/@a-gilmore/pyneoinstance-a-user-friendly-python-library-for-neo4j-dbefa3117bb2).
+* Data Ingestion: [PyNeoInstance: A User-Friendly Python Library for Neo4j](https://medium.com/@a-gilmore/pyneoinstance-a-user-friendly-python-library-for-neo4j-dbefa3117bb2).
 * Graph EDA: [Performing graph EDA with the PyNeoInstance Python Package](https://medium.com/@jose.alvarado-guzman/0c0f6f230aa9)
+* ETL Best Practices: [Python & Neo4j: ETL Best Practices](https://medium.com/@jose.alvarado-guzman/python-neo4j-etl-best-practices-83265ee201d6)

{pyneoinstance-4.0.0 → pyneoinstance-4.0.2}/README.md

@@ -93,7 +93,7 @@ This YAML file can then be loaded in Python and this information can be retrieve
 ```python
 from pyneoinstance import load_yaml_file
 
-config = load_yaml_file(configuration.yaml)
+config = load_yaml_file('configuration.yaml')
 db_info = config['db_info']
 graph = Neo4jInstance(db_info['uri'], db_info['user'], db_info['password'])
 ```
@@ -336,5 +336,6 @@ Open `schema.html` in your browser to explore the schema interactively.
 ## More detailed examples
 
 For more detailed examples please refer to the following articles:
-* Data ingestion: [PyNeoInstance: A User-Friendly Python Library for Neo4j](https://medium.com/@a-gilmore/pyneoinstance-a-user-friendly-python-library-for-neo4j-dbefa3117bb2).
+* Data Ingestion: [PyNeoInstance: A User-Friendly Python Library for Neo4j](https://medium.com/@a-gilmore/pyneoinstance-a-user-friendly-python-library-for-neo4j-dbefa3117bb2).
 * Graph EDA: [Performing graph EDA with the PyNeoInstance Python Package](https://medium.com/@jose.alvarado-guzman/0c0f6f230aa9)
+* ETL Best Practices: [Python & Neo4j: ETL Best Practices](https://medium.com/@jose.alvarado-guzman/python-neo4j-etl-best-practices-83265ee201d6)

{pyneoinstance-4.0.0 → pyneoinstance-4.0.2}/pyneoinstance/__init__.py

@@ -1,5 +1,5 @@
 from .database.neo4jdbms import Neo4jInstance
 from .fileload.loadyaml import load_yaml_file
 
-__version__ = '4.0.0'
+__version__ = '4.0.2'
 __all__ = ['Neo4jInstance', 'load_yaml_file']

{pyneoinstance-4.0.0 → pyneoinstance-4.0.2}/pyneoinstance/database/neo4jdbms.py

@@ -28,6 +28,7 @@ from .context import get_logger, get_batches, get_columns_diff
 
 _NODE_LABEL_RE = re.compile(r"\(:?(\w*)\)")
 _REL_TYPE_RE = re.compile(r"\[:?(\w*)\]")
+_IMPLICIT_TX_RE = re.compile(r"\bIN\s+TRANSACTIONS\b", re.IGNORECASE)
 
 def _get_driver(neo_info : Dict[str, str]):
     try:
@@ -84,8 +85,8 @@ class Neo4jInstance:
                             kwargs: Optional[Dict[str, Any]]) -> None
             Execute a write query to a specific database.
         get_query_visualization(query: str, database: Optional[str],
-                               parameters: Optional[Dict[str, Any]]) -> Network
-            Execute a read query and return the result as a pyvis graph visualization.
+                               parameters: Optional[Dict[str, Any]]) -> VisualizationGraph
+            Execute a read query and return the result as a neo4j-viz graph visualization.
         execute_write_query_with_data(self, query: str, data: DataFrame,
                                       database: Optional[str] = None,
                                       partitions: Optional[int] = 1,
@@ -110,7 +111,7 @@ class Neo4jInstance:
         Parameters
         ----------
         uri : str
-           The Uniform Resource Identifier of the database.
+            The Uniform Resource Identifier of the database.
         user : str
             The Neo4j username.
         password : str
@@ -206,9 +207,7 @@ class Neo4jInstance:
 
     def get_query_visualization(self, query: str,
                                 database: Optional[str] = None,
-                                parameters: Optional[Dict[str, Any]] = None,
-                                node_caption: Optional[str] = 'labels',
-                                relationship_caption: Optional[str] = 'type'
+                                parameters: Optional[Dict[str, Any]] = None
                                ) -> VisualizationGraph:
         """Execute a read query and return the result as a graph visualization.
 
@@ -221,15 +220,12 @@ class Neo4jInstance:
                 If not provided the default database is used.
             parameters : Dict[str, Any], optional
                 Extra arguments containing optional Cypher parameters.
-            node_caption : str, optional
-                Node property to use as the caption. Defaults to 'labels'.
-            relationship_caption : str, optional
-                Relationship property to use as the caption. Defaults to 'type'.
 
             Returns
             -------
             VisualizationGraph
-                neo4j-viz VisualizationGraph object.
+                neo4j-viz VisualizationGraph object. Node captions are derived
+                from node labels; relationship captions from relationship type.
                 In a Jupyter notebook call ``vg.render()`` to display it inline.
                 To save as a standalone HTML file, wrap the fragment in a full document::
 
@@ -253,9 +249,7 @@ class Neo4jInstance:
                 raise ServiceUnavailable() from exception
             except ClientError as exception:
                 raise ClientError(str(exception)) from exception
-        return from_neo4j(graph,
-                          node_caption=node_caption,
-                          relationship_caption=relationship_caption)
+        return from_neo4j(graph)
 
     def execute_write_queries(self, queries: List[str],
                             database: Optional[str] = None,
@@ -757,15 +751,18 @@ class Neo4jInstance:
                        parameters: Optional[Dict[str, Any]] = None
                       ):
         params = parameters or {}
+        kwargs = dict(params)
+        if rows is not None:
+            kwargs['rows'] = rows
         try:
-            if rows is not None:
-                results = session.execute_write(
-                    _write_transaction_function, query,
-                    rows = rows, **params).counters.__dict__
+            if _IMPLICIT_TX_RE.search(query):
+                # 'CALL { ... } IN TRANSACTIONS' is only valid in an implicit
+                # (auto-commit) transaction, so it can't go through execute_write.
+                results = session.run(query, **kwargs).consume().counters.__dict__
             else:
                 results = session.execute_write(
                     _write_transaction_function, query,
-                    **params).counters.__dict__
+                    **kwargs).counters.__dict__
         except ServiceUnavailable as exception:
             raise ServiceUnavailable() from exception
         except ClientError as exception:

{pyneoinstance-4.0.0 → pyneoinstance-4.0.2/pyneoinstance.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyneoinstance
-Version: 4.0.0
+Version: 4.0.2
 Summary: Handle Neo4j read and write transactions and provide methods for performing graph EDA
 Author-email: "Jose A. Alvarado-Guzman" <jose.alvarado-guzman@neo4j.com>
 License: GNU GENERAL PUBLIC LICENSE
@@ -694,9 +694,10 @@ Requires-Dist: neo4j-rust-ext>=5.0.0
 Requires-Dist: pandas>=1.3.0
 Requires-Dist: PyYAML>=5.1
 Requires-Dist: pyvis>=0.3.0
-Requires-Dist: neo4j-viz>=0.5.0
+Requires-Dist: neo4j-viz>=1.0.0
 Provides-Extra: docs
 Requires-Dist: mkdocs-material>=9.0.0; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24.0; extra == "docs"
 Dynamic: license-file
 
 # PyNeoInstance Package
@@ -794,7 +795,7 @@ This YAML file can then be loaded in Python and this information can be retrieve
 ```python
 from pyneoinstance import load_yaml_file
 
-config = load_yaml_file(configuration.yaml)
+config = load_yaml_file('configuration.yaml')
 db_info = config['db_info']
 graph = Neo4jInstance(db_info['uri'], db_info['user'], db_info['password'])
 ```
@@ -1037,5 +1038,6 @@ Open `schema.html` in your browser to explore the schema interactively.
 ## More detailed examples
 
 For more detailed examples please refer to the following articles:
-* Data ingestion: [PyNeoInstance: A User-Friendly Python Library for Neo4j](https://medium.com/@a-gilmore/pyneoinstance-a-user-friendly-python-library-for-neo4j-dbefa3117bb2).
+* Data Ingestion: [PyNeoInstance: A User-Friendly Python Library for Neo4j](https://medium.com/@a-gilmore/pyneoinstance-a-user-friendly-python-library-for-neo4j-dbefa3117bb2).
 * Graph EDA: [Performing graph EDA with the PyNeoInstance Python Package](https://medium.com/@jose.alvarado-guzman/0c0f6f230aa9)
+* ETL Best Practices: [Python & Neo4j: ETL Best Practices](https://medium.com/@jose.alvarado-guzman/python-neo4j-etl-best-practices-83265ee201d6)

{pyneoinstance-4.0.0 → pyneoinstance-4.0.2}/pyneoinstance.egg-info/requires.txt

@@ -2,7 +2,8 @@ neo4j-rust-ext>=5.0.0
 pandas>=1.3.0
 PyYAML>=5.1
 pyvis>=0.3.0
-neo4j-viz>=0.5.0
+neo4j-viz>=1.0.0
 
 [docs]
 mkdocs-material>=9.0.0
+mkdocstrings[python]>=0.24.0

{pyneoinstance-4.0.0 → pyneoinstance-4.0.2}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyneoinstance"
-version = "4.0.0"
+version = "4.0.2"
 description = "Handle Neo4j read and write transactions and provide methods for performing graph EDA"
 readme = "README.md"
 authors = [{ name = "Jose A. Alvarado-Guzman",email = "jose.alvarado-guzman@neo4j.com" }]
@@ -25,12 +25,12 @@ dependencies = [
     "pandas>=1.3.0",
     "PyYAML>=5.1",
     "pyvis>=0.3.0",
-    "neo4j-viz>=0.5.0"
+    "neo4j-viz>=1.0.0"
 ]
 requires-python = ">=3.10"
 
 [project.optional-dependencies]
-docs = ["mkdocs-material>=9.0.0"]
+docs = ["mkdocs-material>=9.0.0", "mkdocstrings[python]>=0.24.0"]
 
 [tool.setuptools.packages.find]
 exclude = ["test*"]

{pyneoinstance-4.0.0 → pyneoinstance-4.0.2}/test/cypher_queries.yaml

@@ -1,7 +1,7 @@
-database: test
+database: neo4j
 pre_ingest:
-  - CREATE CONSTRAINT nkPerson IF NOT EXISTS FOR(n:Person) REQUIRE (n.personId) IS NODE KEY; 
-  - CREATE CONSTRAINT nkMovie IF NOT EXISTS FOR(n:Movie) REQUIRE (n.movieId) IS NODE KEY;
+  - CREATE CONSTRAINT nkPerson IF NOT EXISTS FOR(n:Person) REQUIRE (n.personId) IS UNIQUE;
+  - CREATE CONSTRAINT nkMovie IF NOT EXISTS FOR(n:Movie) REQUIRE (n.movieId) IS UNIQUE;
 
 queries:
   load_person: |

{pyneoinstance-4.0.0 → pyneoinstance-4.0.2}/test/test_neo4jdb.py

@@ -97,6 +97,20 @@ class TestWriteMethods(unittest.TestCase):
         self.assertEqual(
             {'nodes_created': 1, 'labels_added': 2, 'properties_set': 4}, result)
 
+    def test_execute_write_query_in_transactions(self):
+        """Test a query with 'CALL { ... } IN TRANSACTIONS', which requires
+        an implicit transaction rather than the managed transaction used by
+        execute_write_query for regular queries."""
+        query = """
+            UNWIND range(1, 3) AS i
+            CALL (i) {
+                CREATE (:Actor {id: i})
+            } IN TRANSACTIONS OF 1 ROWS
+        """
+        result = self.graph.execute_write_query(query, self.db)
+        self.assertEqual(
+            {'nodes_created': 3, 'labels_added': 3, 'properties_set': 3}, result)
+
 
 class TestReadAndEdaMethods(unittest.TestCase):
     """Test read and EDA methods. Data is loaded once for the entire class."""

{pyneoinstance-4.0.0 → pyneoinstance-4.0.2}/test/test_util_functions.py

@@ -65,7 +65,7 @@ class TestUtilFunctions(unittest.TestCase):
 
     def test_get_batches(self):
         batch_size = 100_000
-        data = pd.read_csv(os.path.join(test_dir,'age_data.csv'))
+        data = pd.read_csv(os.path.join(test_dir,'people.csv'))
         batches = util.get_batches(data, batch_size)
         records = data.shape[0]
         remainder = records % batch_size