spanner-graph-notebook 1.0.0__tar.gz

spanner_graph_notebook-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# How to contribute
+
+This project has limited capacity for reviewing and accepting open-source
+contributions.  Please see "Contribution process" below.
+
+## Before you begin
+
+### Sign our Contributor License Agreement
+
+Contributions to this project must be accompanied by a
+[Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
+You (or your employer) retain the copyright to your contribution; this simply
+gives us permission to use and redistribute your contributions as part of the
+project.
+
+If you or your current employer have already signed the Google CLA (even if it
+was for a different project), you probably don't need to do it again.
+
+Visit <https://cla.developers.google.com/> to see your current agreements or to
+sign a new one.
+
+### Review our community guidelines
+
+This project follows
+[Google's Open Source Community Guidelines](https://opensource.google/conduct/).
+
+## Contribution process
+
+### Design reviews
+
+Prior to developing any change, please file a
+[GitHub Issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues)
+proposing the change.  The
+proposal should describe the proposed new API as well as any major technical
+considerations for the underlying design.  Additional information or changes to
+the design may be requested based on the review.
+
+In general, the goal of this project is to solve one collection of use cases
+really well.  We're looking for contributions that support that goal.
+
+### Code reviews
+
+All submissions, including submissions by project members, require review. We
+use GitHub pull requests for this purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
+information on using pull requests.

spanner_graph_notebook-1.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

spanner_graph_notebook-1.0.0/MANIFEST.in

@@ -0,0 +1,8 @@
+recursive-include templates *
+recursive-include assets *
+include README.md
+include sample.ipynb
+include CONTRIBUTING.md
+include spanner_graphs/*.csv
+include spanner_graphs/*.json
+include tests/*.json

spanner_graph_notebook-1.0.0/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.1
+Name: spanner-graph-notebook
+Version: 1.0.0
+Summary: Visually query Spanner Graph data in notebooks.
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: networkx
+Requires-Dist: numpy
+Requires-Dist: google-cloud-spanner
+Requires-Dist: ipython
+Requires-Dist: ipywidgets
+Requires-Dist: notebook
+
+# Spanner Graph Notebook: Explore Your Data Visually
+
+
+The Spanner Graph Notebook tool provides an efficient way for you to query [Spanner Graph](https://cloud.google.com/spanner/docs/graph/overview) visually in a notebook environment (e.g. [Jupyter Notebook](https://jupyter.org/) and [Google Colab](https://colab.google/)). Using [GQL](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro) query syntax, you can can extract graph insights and relationship patterns, including node and edge properties, neighbor analysis, schema metadata, and diverse layout topologies.
+
+<img src="./assets/full_viz.png" width="800"/>
+
+## Install dependencies
+
+All dependencies below must be installed before using the tool.
+
+### Install the `gcloud` CLI
+
+`gcloud` CLI is needed for authentication. Follow the installation [manual](https://cloud.google.com/sdk/docs/install) to install.
+
+### Install dependencies
+
+Download this package and install its dependencies. Python dependencies should ideally be installed in a managed Python environment using tools like `conda` or `virtualenv`.
+
+When in the root directory of the package, follow the command below to create a managed Python environment (example based on `virtualenv`) and install dependencies.
+
+```shell
+# Create the virtualenv `viz`.
+python3 -m venv viz
+
+# Activate the virtualenv.
+source viz/bin/activate
+```
+
+```shell
+# Install dependencies.
+pip install .
+```
+
+## Using
+
+### Launch notebook and follow steps in `sample.ipynb`
+
+When in the root directory of the package, run `jupyter notebook` to launch Jupyter Notebook.
+
+```shell
+jupyter notebook
+```
+
+As Jupyter local server runs, it will open up a web portal. You can open open the `sample.ipynb` to step through an example.
+
+<img src="./assets/sample_jupyter.png" width="600"/>
+
+You must run `%load_ext spanner_graphs` to load this package. `sample.ipynb` contains this cell already.
+
+<img src="./assets/load_ext.png" width="600"/>
+
+### `%%spanner_graph` magic command
+
+This package provides a `%%spanner_graph` magic command, which visualizes graph data in the notebook output cell.
+
+### Query and visualize a local dataset with `--mock` flag
+
+Using the `--mock` flag for `%%spanner_graph`, you can visualize local graph datasets without connecting to a live Cloud Spanner database. The mock
+dataset renders a network of `person` and `account` nodes, along with edges in between. There is an inserted cell in `sample.ipynb` for the code below.
+
+```
+%%spanner_graph --mock
+
+```
+
+<img src="./assets/mock_data_result.png" width="600"/>
+
+
+### Visualize graph queries from your Spanner Graph database
+
+#### Authentication
+
+To connect to your Spanner database, you need to first authenticate via `gcloud auth`. `gcloud` CLI is needed to use the tool. Follow the installation [manual](https://cloud.google.com/sdk/docs/install) to install.
+
+`sample.ipynb` has inserted a code cell for authentication below. Running this opens a new browser tab for the Google Cloud authentication process.
+
+```shell
+!gcloud auth application-default login
+```
+
+#### Query and visualize Spanner Graph data
+
+Using the `%%spanner_graph` magic command, you can visualize graph query results from your Spanner database.
+
+The magic command needs to be used with your GCP resource info and a query string:
+ - a GCP project id for `--project` option
+ - a Spanner instance id for `--instance` option
+ - a Spanner Graph database id for `--database` option
+ - a [GQL](https://cloud.google.com/spanner/docs/graph/queries-overview) query string
+
+<img src="./assets/hero_with_properties.png" width="800">
+
+## Query Requirements
+
+### Use `TO_JSON` function to return graph elements
+
+Graph queries **must use** `TO_JSON` function in the `RETURN` statement to visualize paths, nodes and edges. We recommend visualizing **paths** for data completeness and ease of use.
+
+```sql
+👍 Good example returning a path as JSON.
+
+
+GRAPH FinGraph
+MATCH query_path = (person:Person {id: 5})-[owns:Owns]->(accnt:Account)
+RETURN TO_JSON(query_path) AS path_json
+```
+
+```sql
+👍 Good example returning a path as JSON in a multiple-hop query.
+
+GRAPH FinGraph
+MATCH query_path = (src:Account {id: 9})-[edge]->{1,3}(dst:Account)
+RETURN TO_JSON(query_path) as path_json
+```
+
+```sql
+👍 Good example returning multiple paths as JSON.
+
+GRAPH FinGraph
+MATCH path_1 = (person:Person {id: 5})-[:Owns]->(accnt:Account),
+      path_2 = (src:Account {id: 9})-[:Transfers]->(dst:Account)
+RETURN TO_JSON(path_1) as path_1,
+       TO_JSON(path_2) as path_2
+```
+
+```
+👎 Anti-example returning nodes properties rather than JSON format graph elements.
+   Scalar results other than JSON format graph elements cannot be visualized.
+
+GRAPH FinGraph
+MATCH (person:Person {id: 5})-[owns:Owns]->(accnt:Account)
+RETURN person.id AS person,
+       owns.amount AS owns,
+       accnt.id AS accnt;
+```
+
+```sql
+👎 Anti-example returning each node and edges in JSON format verbosely. This will
+   work but not as easy as returning a path directly.
+
+GRAPH FinGraph
+MATCH (person:Person {id: 5})-[owns:Owns]->(accnt:Account)
+RETURN TO_JSON(person) AS person_json,
+       TO_JSON(owns) AS owns_json,
+       TO_JSON(accnt) AS accnt_json,
+```
+
+## Testing changes
+
+After adding new changes, please run unit and integration tests with the command below:
+
+
+```shell
+cd spanner_graphs && python -m unittest discover -s tests -p "*_test.py"
+```

spanner_graph_notebook-1.0.0/README.md

@@ -0,0 +1,156 @@
+# Spanner Graph Notebook: Explore Your Data Visually
+
+
+The Spanner Graph Notebook tool provides an efficient way for you to query [Spanner Graph](https://cloud.google.com/spanner/docs/graph/overview) visually in a notebook environment (e.g. [Jupyter Notebook](https://jupyter.org/) and [Google Colab](https://colab.google/)). Using [GQL](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro) query syntax, you can can extract graph insights and relationship patterns, including node and edge properties, neighbor analysis, schema metadata, and diverse layout topologies.
+
+<img src="./assets/full_viz.png" width="800"/>
+
+## Install dependencies
+
+All dependencies below must be installed before using the tool.
+
+### Install the `gcloud` CLI
+
+`gcloud` CLI is needed for authentication. Follow the installation [manual](https://cloud.google.com/sdk/docs/install) to install.
+
+### Install dependencies
+
+Download this package and install its dependencies. Python dependencies should ideally be installed in a managed Python environment using tools like `conda` or `virtualenv`.
+
+When in the root directory of the package, follow the command below to create a managed Python environment (example based on `virtualenv`) and install dependencies.
+
+```shell
+# Create the virtualenv `viz`.
+python3 -m venv viz
+
+# Activate the virtualenv.
+source viz/bin/activate
+```
+
+```shell
+# Install dependencies.
+pip install .
+```
+
+## Using
+
+### Launch notebook and follow steps in `sample.ipynb`
+
+When in the root directory of the package, run `jupyter notebook` to launch Jupyter Notebook.
+
+```shell
+jupyter notebook
+```
+
+As Jupyter local server runs, it will open up a web portal. You can open open the `sample.ipynb` to step through an example.
+
+<img src="./assets/sample_jupyter.png" width="600"/>
+
+You must run `%load_ext spanner_graphs` to load this package. `sample.ipynb` contains this cell already.
+
+<img src="./assets/load_ext.png" width="600"/>
+
+### `%%spanner_graph` magic command
+
+This package provides a `%%spanner_graph` magic command, which visualizes graph data in the notebook output cell.
+
+### Query and visualize a local dataset with `--mock` flag
+
+Using the `--mock` flag for `%%spanner_graph`, you can visualize local graph datasets without connecting to a live Cloud Spanner database. The mock
+dataset renders a network of `person` and `account` nodes, along with edges in between. There is an inserted cell in `sample.ipynb` for the code below.
+
+```
+%%spanner_graph --mock
+
+```
+
+<img src="./assets/mock_data_result.png" width="600"/>
+
+
+### Visualize graph queries from your Spanner Graph database
+
+#### Authentication
+
+To connect to your Spanner database, you need to first authenticate via `gcloud auth`. `gcloud` CLI is needed to use the tool. Follow the installation [manual](https://cloud.google.com/sdk/docs/install) to install.
+
+`sample.ipynb` has inserted a code cell for authentication below. Running this opens a new browser tab for the Google Cloud authentication process.
+
+```shell
+!gcloud auth application-default login
+```
+
+#### Query and visualize Spanner Graph data
+
+Using the `%%spanner_graph` magic command, you can visualize graph query results from your Spanner database.
+
+The magic command needs to be used with your GCP resource info and a query string:
+ - a GCP project id for `--project` option
+ - a Spanner instance id for `--instance` option
+ - a Spanner Graph database id for `--database` option
+ - a [GQL](https://cloud.google.com/spanner/docs/graph/queries-overview) query string
+
+<img src="./assets/hero_with_properties.png" width="800">
+
+## Query Requirements
+
+### Use `TO_JSON` function to return graph elements
+
+Graph queries **must use** `TO_JSON` function in the `RETURN` statement to visualize paths, nodes and edges. We recommend visualizing **paths** for data completeness and ease of use.
+
+```sql
+👍 Good example returning a path as JSON.
+
+
+GRAPH FinGraph
+MATCH query_path = (person:Person {id: 5})-[owns:Owns]->(accnt:Account)
+RETURN TO_JSON(query_path) AS path_json
+```
+
+```sql
+👍 Good example returning a path as JSON in a multiple-hop query.
+
+GRAPH FinGraph
+MATCH query_path = (src:Account {id: 9})-[edge]->{1,3}(dst:Account)
+RETURN TO_JSON(query_path) as path_json
+```
+
+```sql
+👍 Good example returning multiple paths as JSON.
+
+GRAPH FinGraph
+MATCH path_1 = (person:Person {id: 5})-[:Owns]->(accnt:Account),
+      path_2 = (src:Account {id: 9})-[:Transfers]->(dst:Account)
+RETURN TO_JSON(path_1) as path_1,
+       TO_JSON(path_2) as path_2
+```
+
+```
+👎 Anti-example returning nodes properties rather than JSON format graph elements.
+   Scalar results other than JSON format graph elements cannot be visualized.
+
+GRAPH FinGraph
+MATCH (person:Person {id: 5})-[owns:Owns]->(accnt:Account)
+RETURN person.id AS person,
+       owns.amount AS owns,
+       accnt.id AS accnt;
+```
+
+```sql
+👎 Anti-example returning each node and edges in JSON format verbosely. This will
+   work but not as easy as returning a path directly.
+
+GRAPH FinGraph
+MATCH (person:Person {id: 5})-[owns:Owns]->(accnt:Account)
+RETURN TO_JSON(person) AS person_json,
+       TO_JSON(owns) AS owns_json,
+       TO_JSON(accnt) AS accnt_json,
+```
+
+## Testing changes
+
+After adding new changes, please run unit and integration tests with the command below:
+
+
+```shell
+cd spanner_graphs && python -m unittest discover -s tests -p "*_test.py"
+```