This is an automated email from the ASF dual-hosted git repository.
jin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-ai.git
The following commit(s) were added to refs/heads/main by this push:
new 65e831e doc(client): update README for python-client/SDK (#150)
65e831e is described below
commit 65e831e56c0c7597624f832902f06a7e421ea946
Author: HaoJin Yang <[email protected]>
AuthorDate: Thu Jan 2 16:42:59 2025 +0800
doc(client): update README for python-client/SDK (#150)
---------
Co-authored-by: imbajin <[email protected]>
---
hugegraph-python-client/README.md | 128 +++++++++++++++++++++++++++++++++++---
1 file changed, 119 insertions(+), 9 deletions(-)
diff --git a/hugegraph-python-client/README.md
b/hugegraph-python-client/README.md
index 8f478a6..85383d1 100644
--- a/hugegraph-python-client/README.md
+++ b/hugegraph-python-client/README.md
@@ -1,17 +1,24 @@
-# hugegraph-python
+# hugegraph-python-client
-A Python SDK for Apache HugeGraph
+The `hugegraph-python-client` is a Python client(SDK( for HugeGraph.
+
+It is used to define graph structures, perform CRUD operations on graph data,
manage schemas, and execute Gremlin queries. Both the `hugegraph-llm` and
`hugegraph-ml` modules depend on this foundational library.
## Installation
-```shell
+To install the `hugegraph-python-client`, you can use pip:
+
+```bash
pip3 install hugegraph-python
```
-### Install from source
+### Install from Source (Latest Code)
+
+To install from the source, clone the repository and install the required
dependencies:
```bash
-cd /path/to/hugegraph-python-client
+git clone https://github.com/apache/incubator-hugegraph-ai.git
+cd path/to/hugegraph-python-client
# Normal install
pip install .
@@ -20,11 +27,16 @@ pip install .
pip install -e .
```
-## Examples
+## Usage
+
+### Defining Graph Structures
+
+You can use the `hugegraph-python-client` to define graph structures. Below is
an example of how to define a graph:
```python
from pyhugegraph.client import PyHugeClient
+# Initialize the client
# For HugeGraph API version ≥ v3: (Or enable graphspace function)
# - The 'graphspace' parameter becomes relevant if graphspaces are
enabled.(default name is 'DEFAULT')
# - Otherwise, the graphspace parameter is optional and can be ignored.
@@ -46,7 +58,7 @@ print(schema.getVertexLabels())
print(schema.getEdgeLabels())
print(schema.getRelations())
-"""Init Graph"""
+# Init Graph
g = client.graph()
g.addVertex("Person", {"name": "Al Pacino", "birthDate": "1940-04-25"})
g.addVertex("Person", {"name": "Robert De Niro", "birthDate": "1943-08-17"})
@@ -60,12 +72,110 @@ g.addEdge("ActedIn", "12:Al Pacino", "13:The Godfather
Coda The Death of Michael
g.addEdge("ActedIn", "12:Robert De Niro", "13:The Godfather Part II", {})
res = g.getVertexById("12:Al Pacino").label
-# g.removeVertexById("12:Al Pacino")
print(res)
g.close()
+```
+
+### Schema Management
+
+The `hugegraph-python-client` provides comprehensive schema management
capabilities.
+
+#### Define Property Keys
+
+```python
+# Define a property key
+client.schema().propertyKey('name').dataType('STRING').cardinality('SINGLE').create()
+```
+
+#### Define Vertex Labels
+
+```python
+# Define a vertex label
+client.schema().vertexLabel('person').properties('name',
'age').primaryKeys('name').create()
+```
+
+#### Define Edge Labels
+
+```python
+# Define an edge label
+client.schema().edgeLabel('knows').sourceLabel('person').targetLabel('person').properties('since').create()
+```
+
+#### Define Index Labels
+
+```python
+# Define an index label
+client.schema().indexLabel('personByName').onV('person').by('name').secondary().create()
+```
+
+### CRUD Operations
+
+The client allows you to perform CRUD operations on the graph data. Below are
examples of how to create, read, update, and delete vertices and edges:
+
+#### Create Vertices and Edges
-"""Execute Gremlin Query"""
+```python
+# Create vertices
+v1 = client.graph().addVertex('person').property('name',
'John').property('age', 29).create()
+v2 = client.graph().addVertex('person').property('name',
'Jane').property('age', 25).create()
+
+# Create an edge
+client.graph().addEdge(v1, 'knows', v2).property('since', '2020').create()
+```
+
+#### Read Vertices and Edges
+
+```python
+# Get a vertex by ID
+vertex = client.graph().getVertexById(v1.id)
+print(vertex)
+
+# Get an edge by ID
+edge = client.graph().getEdgeById(edge.id)
+print(edge)
+```
+
+#### Update Vertices and Edges
+
+```python
+# Update a vertex
+client.graph().updateVertex(v1.id).property('age', 30).update()
+
+# Update an edge
+client.graph().updateEdge(edge.id).property('since', '2021').update()
+```
+
+#### Delete Vertices and Edges
+
+```python
+# Delete a vertex
+client.graph().deleteVertex(v1.id)
+
+# Delete an edge
+client.graph().deleteEdge(edge.id)
+```
+
+### Execute Gremlin Queries
+
+The client also supports executing Gremlin queries:
+
+```python
+# Execute a Gremlin query
g = client.gremlin()
res = g.exec("g.V().limit(5)")
print(res)
```
+
+Other info are under 🚧 (Welcome to add more docs for it, users could refer
[java-client-doc]([url](https://hugegraph.apache.org/docs/clients/hugegraph-client/))
for similar usage)
+
+## Contributing
+
+* Welcome to contribute to `hugegraph-python-client`. Please see the
[Guidelines](https://hugegraph.apache.org/docs/contribution-guidelines/) for
more information.
+* Code format: Please run `./style/code_format_and_analysis.sh` to format your
code before submitting a PR.
+
+Thank you to all the people who already contributed to
`hugegraph-python-client`!
+
+## Contact Us
+
+* [GitHub Issues](https://github.com/apache/incubator-hugegraph-ai/issues):
Feedback on usage issues and functional requirements (quick response)
+* Feedback Email: [[email protected]]() (subscriber only)
