pyneoinstance 2.2.0__tar.gz → 4.0.0__tar.gz

{pyneoinstance-2.2.0 → pyneoinstance-4.0.0}/MANIFEST.in

@@ -1,3 +1,3 @@
 include test/*.yaml
 include test/*.csv
-recursive-exclude images
+recursive-exclude images *

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: pyneoinstance
-Version: 2.2.0
-Summary: Handle Neo4j read and write transactions and provide methos for performing graph EDA
+Version: 4.0.0
+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
                                Version 3, 29 June 2007
@@ -678,21 +678,34 @@ License: GNU GENERAL PUBLIC LICENSE
         Public License instead of this License.  But first, please read
         <https://www.gnu.org/licenses/why-not-lgpl.html>.
         
+Project-URL: Repository, https://github.com/jose-alvarado-guzman/pyneoingest
+Project-URL: Documentation, https://jose-alvarado-guzman.github.io/pyneoingest/
 Keywords: neo4j,graph,cypher
-Classifier: License :: OSI Approved :: GNU General Public License (GPL)
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Programming Language :: Python :: 3
-Classifier: Development Status :: 4 - Beta
-Requires-Python: >=3.8
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Development Status :: 5 - Production/Stable
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: neo4j>=5.0.0
-Requires-Dist: pandas
-Requires-Dist: PyYAML
-Requires-Dist: pyvis
+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
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.0.0; extra == "docs"
 Dynamic: license-file
 
 # PyNeoInstance Package
 
+<table>
+<tr>
+<td><img src="https://raw.githubusercontent.com/jose-alvarado-guzman/pyneoingest/main/images/PyNeoInstanceLogo.png" alt="PyNeoInstance Logo" width="300"></td>
+<td valign="top">
+
 ## What is it?
 
 PyNeoInstance is a Python package that provides a user friendly API for submitting Cypher queries to Neo4j and performing Exploratory Data Analysis (EDA) of your graph.
@@ -712,14 +725,25 @@ It supports the following features:
 - __<u>Constraints</u>__: Get information of all constraints in the graph.
 - __<u>Indexes</u>__: Get information of all indexes in the graph.
 - __<u>Schema Visualization</u>__: Visualize the graph schema.
+- __<u>Query Graph Visualization</u>__: Visualize the result of a Cypher query as an interactive graph.
+
+</td>
+</tr>
+</table>
+
 
+## Documentation
+
+Full documentation is available at **https://jose-alvarado-guzman.github.io/pyneoingest/**
 
 ## How to install it?
 
-```python
+```bash
 pip install pyneoinstance
 ```
 
+The Rust-accelerated Neo4j driver (`neo4j-rust-ext`) is included by default for faster data serialization.
+
 ## How to use it?
 
 ### Instantiating the Neo4jInstance class
@@ -801,7 +825,7 @@ query = """
            m.tagline AS tagline;
 """
 
-data = graph.execute_read_query(query, db_info['database'], db_info['database'], parameters={'movie_title':'The Matrix'})
+data = graph.execute_read_query(query, db_info['database'], parameters={'movie_title':'The Matrix'})
 ```
 
 ### Submitting a Cypher write query
@@ -818,9 +842,9 @@ query = """
 
 results = graph.execute_write_query(query, db_info['database'],
   parameters={
-    'movie_title':'Wakanda Forever',
-    'year'=2022,
-    tagline=''Wakanda Forever! Long Live Wakanda! For Honor, For Legacy, For Wakanda!''
+    'movie_title': 'Wakanda Forever',
+    'year': 2022,
+    'tagline': 'Wakanda Forever! Long Live Wakanda! For Honor, For Legacy, For Wakanda!'
   })
 ```
 
@@ -830,7 +854,7 @@ We can update a Neo4j database with data contained in a Pandas Data Frame using
 
 - _data_: Pandas Data Frame containing data to process.
 - _database_: Optional, database on which to execute the queries.
-- _partitions_: Optional, number of partitions use to break the Data Frame in smaller chucks.
+- _batchSize_: Optional, number of records per batch use to break the Data Frame in smaller chucks.
 - _parallel_: Whether to execute the query using multiple Python process.
 - _workers_: The number of processes to spawn to execute the queries in parallel.
 - _parameters_: Extra arguments containing optional cypher parameters.
@@ -910,25 +934,25 @@ node_load_queries = config['loading_queries']['nodes']
 person_load_result = graph.execute_write_query_with_data(node_load_queries['Person'], person_data, db_info['database'])
 ```
 
-If the number of rows in your Data Frame is 100K or more it is recommended to break the Data Frame in smaller chunks so that they can be process in different transactions. This will avoid running out of heap error. To do this, just indicate in the _partitions_ argument how many partitions would you like to break this Data Frame into. These partitions will be loaded in different sequential transactions unless you specified loading them in parallel by setting the _parallel_ argument to true. We will discuss this process in the next section.
+If the number of rows in your Data Frame is 100K or more it is recommended to break the Data Frame in smaller chunks so that they can be process in different transactions. This will avoid running out of heap error. To do this, just indicate in the _batchSize_ argument the number of records per data batch to break this Data Frame into smaller data batches. These partitions will be loaded in different sequential transactions unless you specified loading them in parallel by setting the _parallel_ argument to true. We will discuss this process in the next section.
 
 ```python
 person_load_result = graph.execute_write_query_with_data(
     node_load_queries['person'],
     person_data,
     db_info['database'],
-    partitions = 5
+    batchSize = 100000
     )
 ```
 ## Updating a database with data in a Data Frame: Parallel  
 
-To load the data in the Data Frame in parallel, we need to partition the Data Frame by incrementing the _partitions_ argument and set the _parallel_ argument to true. By default, this will use all the available virtual CPUs in the machine. If you need to use less, you can specify how many to use by setting the _workers_ argument.
+To load the data in the Data Frame in parallel, we need to partition the Data Frame by incrementing the _batchSize_ argument and set the _parallel_ argument to true. By default, this will use all the available virtual CPUs in the machine. If you need to use less, you can specify how many to use by setting the _workers_ argument.
 
 ```python
 person_load_result = graph.execute_write_query_with_data(
     node_load_queries['person'],
     person_data,
-    partitions = 5,
+    batchSize = 100000,
     parallel = True,
     workers = 5
     )
@@ -959,7 +983,7 @@ graph.get_rela_type_freq(database='mydbname')
 ### Properties
 The get_properties method provides information about all the nodes and relationships properties.
 ```python
-graph.graph.get_properties(database='mydbname')
+graph.get_properties(database='mydbname')
 ```
 <img src="https://s3.amazonaws.com/neo4j-ps-ds-bootcamp/img/properties.png" width="350" hight="300">
 
@@ -977,21 +1001,37 @@ graph.get_indexes(database='mydbname')
 ```
 <img src="https://s3.amazonaws.com/neo4j-ps-ds-bootcamp/img/indexes.png" width="450" hight="400">
 
-### Schema Visualization
-The graph.get_schema_visualization provides an interactive UI with the visualization of the graph schema with the ability to filter the schema. This UI can be access via a Notebook or HTML page. This visualization displays the node labels as string close to nodes, relationship types are only display on mouse hover.
+### Query Graph Visualization
+The `get_query_visualization` method executes a Cypher query that returns nodes and relationships and renders the result as an interactive graph. Node labels are displayed as captions and all properties appear as tooltips on hover.
 
 ```python
-schema = graph.get_schema_visualization(database='mydbname')
-schema.show('schema.html')
+query = """
+    MATCH (p:Person)-[r:ACTED_IN]->(m:Movie)
+    RETURN p, r, m
+    LIMIT 50
+"""
+vg = graph.get_query_visualization(query, database='mydbname')
+
+# In a Jupyter notebook — renders inline:
+vg.render()
+
+# As a standalone HTML file:
+with open('graph.html', 'w') as f:
+    f.write(f'<!DOCTYPE html><html><body>{vg.render().data}</body></html>')
 ```
-<img src="https://s3.amazonaws.com/neo4j-ps-ds-bootcamp/img/schema.png" width="450" hight="400">
+<img src="https://raw.githubusercontent.com/jose-alvarado-guzman/pyneoingest/main/images/query_visualization.png" alt="Query Graph Visualization" width="600">
 
-To access the UI via HTTML page just set the parameter notebook to false in the show method and open the html file in your browser.
+### Schema Visualization
+The `get_schema_visualization` method provides an interactive visualization of the graph schema with the ability to filter by label. Node labels are displayed as strings next to nodes; relationship types are shown on mouse hover.
 
 ```python
 schema = graph.get_schema_visualization(database='mydbname')
-schema.show('schema.html',notebook=False)
+schema.write_html('schema.html')
 ```
+
+Open `schema.html` in your browser to explore the schema interactively.
+
+<img src="https://s3.amazonaws.com/neo4j-ps-ds-bootcamp/img/schema.png" width="450" hight="400">
 <img src="https://s3.amazonaws.com/neo4j-ps-ds-bootcamp/img/schemaHtml.png" width="450" hight="400">
 
 ## More detailed examples

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

@@ -1,5 +1,10 @@
 # PyNeoInstance Package
 
+<table>
+<tr>
+<td><img src="https://raw.githubusercontent.com/jose-alvarado-guzman/pyneoingest/main/images/PyNeoInstanceLogo.png" alt="PyNeoInstance Logo" width="300"></td>
+<td valign="top">
+
 ## What is it?
 
 PyNeoInstance is a Python package that provides a user friendly API for submitting Cypher queries to Neo4j and performing Exploratory Data Analysis (EDA) of your graph.
@@ -19,14 +24,25 @@ It supports the following features:
 - __<u>Constraints</u>__: Get information of all constraints in the graph.
 - __<u>Indexes</u>__: Get information of all indexes in the graph.
 - __<u>Schema Visualization</u>__: Visualize the graph schema.
+- __<u>Query Graph Visualization</u>__: Visualize the result of a Cypher query as an interactive graph.
+
+</td>
+</tr>
+</table>
+
 
+## Documentation
+
+Full documentation is available at **https://jose-alvarado-guzman.github.io/pyneoingest/**
 
 ## How to install it?
 
-```python
+```bash
 pip install pyneoinstance
 ```
 
+The Rust-accelerated Neo4j driver (`neo4j-rust-ext`) is included by default for faster data serialization.
+
 ## How to use it?
 
 ### Instantiating the Neo4jInstance class
@@ -108,7 +124,7 @@ query = """
            m.tagline AS tagline;
 """
 
-data = graph.execute_read_query(query, db_info['database'], db_info['database'], parameters={'movie_title':'The Matrix'})
+data = graph.execute_read_query(query, db_info['database'], parameters={'movie_title':'The Matrix'})
 ```
 
 ### Submitting a Cypher write query
@@ -125,9 +141,9 @@ query = """
 
 results = graph.execute_write_query(query, db_info['database'],
   parameters={
-    'movie_title':'Wakanda Forever',
-    'year'=2022,
-    tagline=''Wakanda Forever! Long Live Wakanda! For Honor, For Legacy, For Wakanda!''
+    'movie_title': 'Wakanda Forever',
+    'year': 2022,
+    'tagline': 'Wakanda Forever! Long Live Wakanda! For Honor, For Legacy, For Wakanda!'
   })
 ```
 
@@ -137,7 +153,7 @@ We can update a Neo4j database with data contained in a Pandas Data Frame using
 
 - _data_: Pandas Data Frame containing data to process.
 - _database_: Optional, database on which to execute the queries.
-- _partitions_: Optional, number of partitions use to break the Data Frame in smaller chucks.
+- _batchSize_: Optional, number of records per batch use to break the Data Frame in smaller chucks.
 - _parallel_: Whether to execute the query using multiple Python process.
 - _workers_: The number of processes to spawn to execute the queries in parallel.
 - _parameters_: Extra arguments containing optional cypher parameters.
@@ -217,25 +233,25 @@ node_load_queries = config['loading_queries']['nodes']
 person_load_result = graph.execute_write_query_with_data(node_load_queries['Person'], person_data, db_info['database'])
 ```
 
-If the number of rows in your Data Frame is 100K or more it is recommended to break the Data Frame in smaller chunks so that they can be process in different transactions. This will avoid running out of heap error. To do this, just indicate in the _partitions_ argument how many partitions would you like to break this Data Frame into. These partitions will be loaded in different sequential transactions unless you specified loading them in parallel by setting the _parallel_ argument to true. We will discuss this process in the next section.
+If the number of rows in your Data Frame is 100K or more it is recommended to break the Data Frame in smaller chunks so that they can be process in different transactions. This will avoid running out of heap error. To do this, just indicate in the _batchSize_ argument the number of records per data batch to break this Data Frame into smaller data batches. These partitions will be loaded in different sequential transactions unless you specified loading them in parallel by setting the _parallel_ argument to true. We will discuss this process in the next section.
 
 ```python
 person_load_result = graph.execute_write_query_with_data(
     node_load_queries['person'],
     person_data,
     db_info['database'],
-    partitions = 5
+    batchSize = 100000
     )
 ```
 ## Updating a database with data in a Data Frame: Parallel  
 
-To load the data in the Data Frame in parallel, we need to partition the Data Frame by incrementing the _partitions_ argument and set the _parallel_ argument to true. By default, this will use all the available virtual CPUs in the machine. If you need to use less, you can specify how many to use by setting the _workers_ argument.
+To load the data in the Data Frame in parallel, we need to partition the Data Frame by incrementing the _batchSize_ argument and set the _parallel_ argument to true. By default, this will use all the available virtual CPUs in the machine. If you need to use less, you can specify how many to use by setting the _workers_ argument.
 
 ```python
 person_load_result = graph.execute_write_query_with_data(
     node_load_queries['person'],
     person_data,
-    partitions = 5,
+    batchSize = 100000,
     parallel = True,
     workers = 5
     )
@@ -266,7 +282,7 @@ graph.get_rela_type_freq(database='mydbname')
 ### Properties
 The get_properties method provides information about all the nodes and relationships properties.
 ```python
-graph.graph.get_properties(database='mydbname')
+graph.get_properties(database='mydbname')
 ```
 <img src="https://s3.amazonaws.com/neo4j-ps-ds-bootcamp/img/properties.png" width="350" hight="300">
 
@@ -284,25 +300,41 @@ graph.get_indexes(database='mydbname')
 ```
 <img src="https://s3.amazonaws.com/neo4j-ps-ds-bootcamp/img/indexes.png" width="450" hight="400">
 
-### Schema Visualization
-The graph.get_schema_visualization provides an interactive UI with the visualization of the graph schema with the ability to filter the schema. This UI can be access via a Notebook or HTML page. This visualization displays the node labels as string close to nodes, relationship types are only display on mouse hover.
+### Query Graph Visualization
+The `get_query_visualization` method executes a Cypher query that returns nodes and relationships and renders the result as an interactive graph. Node labels are displayed as captions and all properties appear as tooltips on hover.
 
 ```python
-schema = graph.get_schema_visualization(database='mydbname')
-schema.show('schema.html')
+query = """
+    MATCH (p:Person)-[r:ACTED_IN]->(m:Movie)
+    RETURN p, r, m
+    LIMIT 50
+"""
+vg = graph.get_query_visualization(query, database='mydbname')
+
+# In a Jupyter notebook — renders inline:
+vg.render()
+
+# As a standalone HTML file:
+with open('graph.html', 'w') as f:
+    f.write(f'<!DOCTYPE html><html><body>{vg.render().data}</body></html>')
 ```
-<img src="https://s3.amazonaws.com/neo4j-ps-ds-bootcamp/img/schema.png" width="450" hight="400">
+<img src="https://raw.githubusercontent.com/jose-alvarado-guzman/pyneoingest/main/images/query_visualization.png" alt="Query Graph Visualization" width="600">
 
-To access the UI via HTTML page just set the parameter notebook to false in the show method and open the html file in your browser.
+### Schema Visualization
+The `get_schema_visualization` method provides an interactive visualization of the graph schema with the ability to filter by label. Node labels are displayed as strings next to nodes; relationship types are shown on mouse hover.
 
 ```python
 schema = graph.get_schema_visualization(database='mydbname')
-schema.show('schema.html',notebook=False)
+schema.write_html('schema.html')
 ```
+
+Open `schema.html` in your browser to explore the schema interactively.
+
+<img src="https://s3.amazonaws.com/neo4j-ps-ds-bootcamp/img/schema.png" width="450" hight="400">
 <img src="https://s3.amazonaws.com/neo4j-ps-ds-bootcamp/img/schemaHtml.png" width="450" hight="400">
 
 ## 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).
-* Graph EDA: [Performing graph EDA with the PyNeoInstance Python Package](https://medium.com/@jose.alvarado-guzman/0c0f6f230aa9)
+* Graph EDA: [Performing graph EDA with the PyNeoInstance Python Package](https://medium.com/@jose.alvarado-guzman/0c0f6f230aa9)

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

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

pyneoinstance-4.0.0/pyneoinstance/database/context.py

@@ -0,0 +1,6 @@
+"""Re-exports utility functions for use by the database module."""
+import os
+import sys
+sys.path.insert(0, os.path.abspath(
+    os.path.join(os.path.dirname(__file__), '..')))
+from pyneoinstance.util.functions import get_logger,get_batches,get_columns_diff