Merge pull request #1 from ccozad/neo4j

Neo4j example

Author: ccozad

README.md

@@ -40,15 +40,15 @@ See this video for additional commentary on [Python Dev Environment Setup](https
    - On Windows: `.venv\Scripts\activate`
  - *Install dependencies*
    - On Mac: `pip install -r requirements.txt`
-   - On Windoes: `pip install -r requirements.txt`
+   - On Windows: `pip install -r requirements.txt`
  - *Run tests*
    - `pytest -rA`
 
 # Topics
 Here's what you can find here:
 
 ## [Algorithms](/algorithms/)
-- [Binary search](/algorithms/binary_search_client.py) an efficent search within sorted lists
+- [Binary search](/algorithms/binary_search_client.py) an efficient search within sorted lists
 - [Binary search tree](/algorithms/binary_tree.py) a specially organized binary tree that allows divide and conquer searches
 - [Hamming distance](/algorithms/hamming_distance.py) Number of positions in which symbols differ for two equal length strings
 - [Inorder tree traversal](/algorithms/binary_search_tree_walker.py) Traverse a binary search tree inorder to list nodes in sorted ascending order
@@ -77,6 +77,10 @@ Here's what you can find here:
  - [Load CSV into a pandas dataframe](/data_science/load_csv.py) 
  - [Group data and then find statistics for each group](/data_science/stats_by_group.py)
 
+## Databases
+ - [Neo4j](/databases/neo4j/)
+   - [Run a simple query against Neo4j](/databases/neo4j/simple.py)
+
 ## [Games](/games/)
  - Boards
    - [2D grid](/games/boards/grid_2d.py) A simple representation of a 2D grid board that can be used for games like tic-tac-toe or checkers

azure/key_vault/README.md

@@ -12,7 +12,7 @@ Change `example.env` to `.env`
 
 # Execution Order
 
-All of the examples have guards if they are run before preconditions are met. The recomended order to run things and have something actually happen is
+All of the examples have guards if they are run before preconditions are met. The recommended order to run things and have something actually happen is
 
  1. `set_secret.py`
  2. `get_secret.py`

databases/neo4j/.gitignore

@@ -0,0 +1,2 @@
+.venv/
+.env

databases/neo4j/README.md

@@ -0,0 +1,67 @@
+# Introduction
+
+This set of examples assumes you have the movie database loaded
+
+See https://neo4j.com/graphgists/cypher-introduction-social-movie-database/ for details on the movie database.
+
+# Dependencies
+
+All of the dependencies listed below need to be in place before running the code.
+
+ - Python virtual environment
+ - Environment variables
+
+## Python Virtual Environment
+
+ - Move to the neo4j folder
+   - `cd <neo4j>`
+ - Create a virtual environment
+   - On Mac: `python3 -m venv .venv`
+   - On Windows: `python -m venv .venv`
+ - Activate the virtual environment
+   - On Mac: `source .venv/bin/activate`
+   - On Windows: `.venv\Scripts\activate`
+ - Install dependencies
+   - On Mac: `pip3 install -r requirements.txt`
+   - On Windows: `pip install -r requirements.txt`
+ - Call a specific script
+   - On Mac: `python3 <script_name>.py`
+   - On Windows: `python <script_name>.py`
+ - Deactivate virtual environment
+   - `deactivate`
+
+## Environment Variables
+
+Create a file named `.env` with the contents shown below
+
+```
+NEO4J_URI=<address>
+NEO4J_USER=<user>
+NEO4J_PASSWORD=<password>
+```
+
+# Example Output
+
+## simple.py
+
+```text
+python3 simple.py
+
+Successfully connected to Neo4j
+Running a simple query:
+Movies that Tom Hanks acted in:
+ -  Apollo 13
+ -  You've Got Mail
+ -  A League of Their Own
+ -  Joe Versus the Volcano
+ -  That Thing You Do
+ -  The Da Vinci Code
+ -  Cloud Atlas
+ -  Cast Away
+ -  The Green Mile
+ -  Sleepless in Seattle
+ -  The Polar Express
+ -  Charlie Wilson's War
+
+The query `MATCH (actor:Person {name: $name})-[:ACTED_IN]->(movies) RETURN actor,movies` returned 12 records in 9 ms.
+```

databases/neo4j/requirements.txt

@@ -0,0 +1,2 @@
+python-dotenv
+neo4j

databases/neo4j/simple.py

@@ -0,0 +1,37 @@
+# This example assumes you have the movie database loadeed
+from neo4j import GraphDatabase
+
+import os
+import dotenv
+dotenv.load_dotenv()
+neo4j_uri = os.getenv("NEO4J_URI")
+neo4j_user = os.getenv("NEO4J_USER")
+neo4j_password = os.getenv("NEO4J_PASSWORD")
+auth = (neo4j_user, neo4j_password)
+
+with GraphDatabase.driver(neo4j_uri, auth=auth) as driver:
+    driver.verify_connectivity()
+
+    print("Successfully connected to Neo4j")
+
+    print("Running a simple query:")
+
+    records, summary, keys = driver.execute_query(
+        "MATCH (actor:Person {name: $name})-[:ACTED_IN]->(movies) RETURN actor,movies",
+        name="Tom Hanks",
+        database_="neo4j",
+    )
+
+    print("Movies that Tom Hanks acted in:")
+
+    # Loop through results and do something with them
+    for movie in records:
+        title = movie.data().get("movies").get("title")
+        print(" - ", title)
+
+    # Summary information
+    print("\nThe query `{query}` returned {records_count} records in {time} ms.".format(
+        query=summary.query, records_count=len(records),
+        time=summary.result_available_after,
+    ))
+