chore: update repo files

Author: gRedHeadphone

.gitignore

@@ -0,0 +1,65 @@
+*.py[cod]
+*.sw[op]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+.eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+__pycache__
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.nox
+.cache
+.pytest_cache
+
+
+# Mac
+.DS_Store
+
+# JetBrains
+.idea
+
+# VS Code
+.vscode
+
+# emacs
+*~
+
+# Built documentation
+docs/_build
+bigquery/docs/generated
+docs.metadata
+
+# Virtual environment
+env/
+venv/
+.python-version
+
+# Test logs
+coverage.xml
+*sponge_log.xml
+
+# System test environment variables.
+system_tests/local_test_setup
+
+# Make sure a generated file isn't accidentally committed.
+pylintrc
+pylintrc.test

README.md

@@ -1,53 +1,119 @@
-# New Project Template
-
-This repository contains a template that can be used to seed a repository for a
-new Google open source project.
-
-See [go/releasing](http://go/releasing) (available externally at
-https://opensource.google/documentation/reference/releasing) for more information about
-releasing a new Google open source project.
-
-This template uses the Apache license, as is Google's default.  See the
-documentation for instructions on using alternate license.
-
-## How to use this template
-
-1. Clone it from GitHub.
-    * There is no reason to fork it.
-1. Create a new local repository and copy the files from this repo into it.
-1. Modify README.md and docs/contributing.md to represent your project, not the
-   template project.
-1. Develop your new project!
-
-``` shell
-git clone https://github.com/google/new-project
-mkdir my-new-thing
-cd my-new-thing
-git init
-cp -r ../new-project/* ../new-project/.github .
-git add *
-git commit -a -m 'Boilerplate for new Google open source project'
+# Spanner for LlamaIndex
+
+[![preview](https://img.shields.io/badge/support-preview-orange.svg)](https://cloud.google.com/products#product-launch-stages)
+[![pypi](https://img.shields.io/pypi/v/llama-index-spanner.svg)](https://pypi.org/project/llama-index-spanner/)
+[![versions](https://img.shields.io/pypi/pyversions/llama-index-spanner.svg)](https://pypi.org/project/llama-index-spanner/)
+
+  * [Client Library Documentation](https://cloud.google.com/python/docs/reference/llama-index-spanner/latest)
+  * [Product Documentation](https://cloud.google.com/spanner)
+
+## Quick Start
+
+In order to use this library, you first need to go through the following steps:
+
+1.  [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+2.  [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+3.  [Enable the Google Cloud Spanner API.](https://console.cloud.google.com/flows/enableapi?apiid=spanner.googleapis.com)
+4.  [Setup Authentication.](https://googleapis.dev/python/google-api-core/latest/auth.html)
+
+### Installation
+
+Install this library in a [virtualenv](https://virtualenv.pypa.io/en/latest/) using pip. [virtualenv](https://virtualenv.pypa.io/en/latest/) is a tool to create isolated Python environments. The basic problem it addresses is one of dependencies and versions, and indirectly permissions.
+
+With [virtualenv](https://virtualenv.pypa.io/en/latest/), it’s possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.
+
+#### Supported Python Versions
+
+Python \>= 3.9
+
+#### Mac/Linux
+
+```console
+pip install virtualenv
+virtualenv <your-env>
+source <your-env>/bin/activate
+<your-env>/bin/pip install llama-index-spanner
+```
+
+#### Windows
+
+```console
+pip install virtualenv
+virtualenv <your-env>
+<your-env>\Scripts\activate
+<your-env>\Scripts\pip.exe install llama-index-spanner
+```
+
+<!-- ### Spanner Property Graph Store Usage
+
+Use `SpannerPropertyGraphStore` to store nodes and edges extracted from documents.
+
+```python
+from llama_index_spanner import SpannerPropertyGraphStore
+
+graph = SpannerPropertyGraphStore(
+    instance_id="my-instance",
+    database_id="my-database",
+    graph_name="my_graph",
+)
+```
+
+See the full [Spanner Graph Store](https://github.com/googleapis/langchain-google-spanner-python/blob/main/docs/graph_store.ipynb) tutorial.
+
+### Spanner Graph Retrievers Usage
+
+Use `SpannerGraphTextToGQLRetriever` to translate natural language question to GQL and query SpannerGraphStore.
+
+```python
+from langchain_google_spanner import SpannerGraphStore, SpannerGraphTextToGQLRetriever
+from langchain_google_vertexai import ChatVertexAI
+
+graph = SpannerGraphStore(
+    instance_id="my-instance",
+    database_id="my-database",
+    graph_name="my_graph",
+)
+llm = ChatVertexAI()
+retriever = SpannerGraphTextToGQLRetriever.from_params(
+    graph_store=graph,
+    llm=llm
+)
+retriever.invoke("Where does Elias Thorne's sibling live?")
 ```
 
-## Source Code Headers
+Use `SpannerGraphVectorContextRetriever` to perform vector search on embeddings that are stored in the nodes in a SpannerGraphStore. If expand\_by\_hops is provided, the nodes and edges at a distance upto the expand\_by\_hops from the nodes found in the vector search will also be returned.
+
+```python
+from langchain_google_spanner import SpannerGraphStore, SpannerGraphVectorContextRetriever
+from langchain_google_vertexai import ChatVertexAI, VertexAIEmbeddings
+
+graph = SpannerGraphStore(
+    instance_id="my-instance",
+    database_id="my-database",
+    graph_name="my_graph",
+)
+embedding_service = VertexAIEmbeddings(model_name="text-embedding-004")
+retriever = SpannerGraphVectorContextRetriever.from_params(
+            graph_store=graph,
+            embedding_service=embedding_service,
+            label_expr="Person",
+            embeddings_column="embeddings",
+            top_k=1,
+            expand_by_hops=1,
+        )
+retriever.invoke("Who lives in desert?")
+``` -->
 
-Every file containing source code must include copyright and license
-information. This includes any JS/CSS files that you might be serving out to
-browsers. (This is to help well-intentioned people avoid accidental copying that
-doesn't comply with the license.)
+## Contributing
 
-Apache header:
+Contributions to this library are always welcome and highly encouraged.
 
-    Copyright 2024 Google LLC
+See [CONTRIBUTING](CONTRIBUTING.md) for more information how to get started.
 
-    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
+Please note that this project is released with a Contributor Code of Conduct. By participating in
+this project you agree to abide by its terms. See [Code of Conduct](CODE_OF_CONDUCT.md) for more
+information.
 
-        https://www.apache.org/licenses/LICENSE-2.0
+## License
 
-    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.
+Apache 2.0 - See [LICENSE](LICENSE) for more information.