# Unofficial Python Driver for Apache AGE
Official Git Project : https://github.com/apache/age/tree/master/drivers/python
[Apache AGE](https://age.apache.org/) is a PostgreSQL extension that provides graph database functionality. The goal of the Apache AGE project is to create single storage that can handle both relational and graph model data so that users can use standard ANSI SQL along with openCypher, the Graph query language. This repository hosts the development of the Python driver for this Apache extension (currently in Incubator status). Thanks for checking it out.
A graph consists of a set of vertices (also called nodes) and edges, where each individual vertex and edge possesses a map of properties. A vertex is the basic object of a graph, that can exist independently of everything else in the graph. An edge creates a directed connection between two vertices. A graph database is simply composed of vertices and edges. This type of database is useful when the meaning is in the relationships between the data. Relational databases can easily handle direct relationships, but indirect relationships are more difficult to deal with in relational databases. A graph database stores relationship information as a first-class entity. Apache AGE gives you the best of both worlds, simultaneously.
Apache AGE is:
- **Powerful** -- AGE adds graph database support to the already popular PostgreSQL database: PostgreSQL is used by organizations including Apple, Spotify, and NASA.
- **Flexible** -- AGE allows you to perform openCypher queries, which make complex queries much easier to write.
- **Intelligent** -- AGE allows you to perform graph queries that are the basis for many next level web services such as fraud & intrustion detection, master data management, product recommendations, identity and relationship management, experience personalization, knowledge management and more.
### Features
* Cypher query support for Psycopg2 PostreSQL driver (enables cypher queries directly)
* Deserialize AGE result (AGType) to Vertex, Edge, Path
### Requirements
* Python 3.9 or higher
* This module runs on [psycopg2](https://www.psycopg.org/) and [antlr4-python3](https://pypi.org/project/antlr4-python3-runtime/)
```
sudo apt-get update
sudo apt-get install python3-dev libpq-dev
pip install --no-binary :all: psycopg2
pip install antlr4-python3-runtime==4.11.1
```
### Install via PIP
```
pip install apache-age-python
```
### Build from Source
```
git clone https://github.com/rhizome-ai/apache-age-python
cd apache-age-python
python setup.py install
```
### Getting Started
* [Jupyter Notebook: Basic Examples](samples/apache-age-basic.ipynb)
* [Jupyter Notebook: More Complex Examples](samples/apache-age-note.ipynb)
### Tests
```
python -m unittest -v test_age_py.py
python -m unittest -v test_agtypes.py
```
[Agtype data type conversion tests](samples/apache-age-agtypes.ipynb)
### For more information about [Apache AGE](https://age.apache.org/)
* Apache Incubator Age: https://age.apache.org/
* Github: https://github.com/apache/incubator-age
* Documentation: https://age.incubator.apache.org/docs/
* apache-age-python GitHub: https://github.com/rhizome-ai/apache-age-python
### Troubleshooting
1. Make sure AGE is installed.
2. Check to see if AGE is loaded in PostgreSQL.
```
# psql
CREATE EXTENSION age;
LOAD 'age';
SET search_path = ag_catalog, "$user", public;
```
### License
[Apache-2.0 License](https://www.apache.org/licenses/LICENSE-2.0)
Raw data
{
"_id": null,
"home_page": "https://github.com/rhizome-ai/apache-age-python",
"name": "apache-age-python",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "Graph Database,Apache AGE,PostgreSQL",
"author": "Ikchan Kwon",
"author_email": "rhizome.ai@gmail.com",
"download_url": "https://github.com/rhizome-ai/apache-age-python/releases/",
"platform": null,
"description": "# Unofficial Python Driver for Apache AGE\n\nOfficial Git Project : https://github.com/apache/age/tree/master/drivers/python\n\n[Apache AGE](https://age.apache.org/) is a PostgreSQL extension that provides graph database functionality. The goal of the Apache AGE project is to create single storage that can handle both relational and graph model data so that users can use standard ANSI SQL along with openCypher, the Graph query language. This repository hosts the development of the Python driver for this Apache extension (currently in Incubator status). Thanks for checking it out.\n\nA graph consists of a set of vertices (also called nodes) and edges, where each individual vertex and edge possesses a map of properties. A vertex is the basic object of a graph, that can exist independently of everything else in the graph. An edge creates a directed connection between two vertices. A graph database is simply composed of vertices and edges. This type of database is useful when the meaning is in the relationships between the data. Relational databases can easily handle direct relationships, but indirect relationships are more difficult to deal with in relational databases. A graph database stores relationship information as a first-class entity. Apache AGE gives you the best of both worlds, simultaneously.\n\nApache AGE is:\n\n- **Powerful** -- AGE adds graph database support to the already popular PostgreSQL database: PostgreSQL is used by organizations including Apple, Spotify, and NASA.\n- **Flexible** -- AGE allows you to perform openCypher queries, which make complex queries much easier to write.\n- **Intelligent** -- AGE allows you to perform graph queries that are the basis for many next level web services such as fraud & intrustion detection, master data management, product recommendations, identity and relationship management, experience personalization, knowledge management and more.\n\n### Features\n* Cypher query support for Psycopg2 PostreSQL driver (enables cypher queries directly)\n* Deserialize AGE result (AGType) to Vertex, Edge, Path\n\n### Requirements\n* Python 3.9 or higher\n* This module runs on [psycopg2](https://www.psycopg.org/) and [antlr4-python3](https://pypi.org/project/antlr4-python3-runtime/)\n```\nsudo apt-get update\nsudo apt-get install python3-dev libpq-dev\npip install --no-binary :all: psycopg2\npip install antlr4-python3-runtime==4.11.1\n```\n\n### Install via PIP\n``` \npip install apache-age-python\n```\n\n### Build from Source\n``` \ngit clone https://github.com/rhizome-ai/apache-age-python\ncd apache-age-python\n\npython setup.py install\n```\n\n### Getting Started\n* [Jupyter Notebook: Basic Examples](samples/apache-age-basic.ipynb) \n* [Jupyter Notebook: More Complex Examples](samples/apache-age-note.ipynb)\n\n### Tests\n```\npython -m unittest -v test_age_py.py\npython -m unittest -v test_agtypes.py\n```\n[Agtype data type conversion tests](samples/apache-age-agtypes.ipynb)\n\n### For more information about [Apache AGE](https://age.apache.org/)\n* Apache Incubator Age: https://age.apache.org/\n* Github: https://github.com/apache/incubator-age\n* Documentation: https://age.incubator.apache.org/docs/\n* apache-age-python GitHub: https://github.com/rhizome-ai/apache-age-python\n\n### Troubleshooting\n1. Make sure AGE is installed. \n2. Check to see if AGE is loaded in PostgreSQL.\n```\n# psql \nCREATE EXTENSION age;\nLOAD 'age';\nSET search_path = ag_catalog, \"$user\", public;\n```\n### License\n[Apache-2.0 License](https://www.apache.org/licenses/LICENSE-2.0)\n",
"bugtrack_url": null,
"license": "Apache2.0",
"summary": "Python driver support for Apache AGE",
"version": "0.0.6",
"project_urls": {
"Download": "https://github.com/rhizome-ai/apache-age-python/releases/",
"Homepage": "https://github.com/rhizome-ai/apache-age-python"
},
"split_keywords": [
"graph database",
"apache age",
"postgresql"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9eae506bf1e134103a32df3084e7a1ee0dc85e6a36412bfc485be23f26cfe26a",
"md5": "cc4d689b8aca3c409a9c656dd6659c7c",
"sha256": "d3986dc46dff1b03420061dad8e5fc0f855d1a8befb5a328fa60c595aa7813f2"
},
"downloads": -1,
"filename": "apache_age_python-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc4d689b8aca3c409a9c656dd6659c7c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 23009,
"upload_time": "2023-07-15T04:48:05",
"upload_time_iso_8601": "2023-07-15T04:48:05.722533Z",
"url": "https://files.pythonhosted.org/packages/9e/ae/506bf1e134103a32df3084e7a1ee0dc85e6a36412bfc485be23f26cfe26a/apache_age_python-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-15 04:48:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rhizome-ai",
"github_project": "apache-age-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "apache-age-python"
}
JSON
