# FalkorDB
[![license](https://img.shields.io/github/license/falkordb/falkordb-py.svg)](https://github.com/falkordb/falkordb-py)
[![Release](https://img.shields.io/github/release/falkordb/falkordb-py.svg)](https://github.com/falkordb/falkordb-py/releases/latest)
[![PyPI version](https://badge.fury.io/py/falkordb.svg)](https://badge.fury.io/py/falkordb)
[![Codecov](https://codecov.io/gh/falkordb/falkordb-py/branch/main/graph/badge.svg)](https://codecov.io/gh/falkordb/falkordb-py)
[![Forum](https://img.shields.io/badge/Forum-falkordb-blue)](https://github.com/orgs/FalkorDB/discussions)
[![Discord](https://img.shields.io/discord/1146782921294884966?style=flat-square)](https://discord.gg/ErBEqN9E)
FalkorDB python client
see [docs](http://falkordb-py.readthedocs.io/)
## Installation
```sh
pip install FalkorDB
```
## Usage
### Run FalkorDB instance
Docker:
```sh
docker run --rm -p 6379:6379 falkordb/falkordb
```
Or use our [sandbox](https://cloud.falkordb.com/sandbox)
### Example
```python
from falkordb import FalkorDB
# Connect to FalkorDB
db = FalkorDB(host='localhost', port=6379)
# Select the social graph
g = db.select_graph('social')
# Create 100 nodes and return a handful
nodes = g.query('UNWIND range(0, 100) AS i CREATE (n {v:1}) RETURN n LIMIT 10').result_set
for n in nodes:
print(n)
```
Raw data
{
"_id": null,
"home_page": "http://falkordb-py.readthedocs.io",
"name": "FalkorDB",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "FalkorDB,GraphDB,Cypher",
"author": "FalkorDB inc",
"author_email": "info@falkordb.com",
"download_url": "https://files.pythonhosted.org/packages/6e/81/5f4cdf7cb5f806d2686d3e089607bf245e316c87fa8dab08b2b08898ad77/falkordb-1.0.2.tar.gz",
"platform": null,
"description": "# FalkorDB\n\n[![license](https://img.shields.io/github/license/falkordb/falkordb-py.svg)](https://github.com/falkordb/falkordb-py)\n[![Release](https://img.shields.io/github/release/falkordb/falkordb-py.svg)](https://github.com/falkordb/falkordb-py/releases/latest)\n[![PyPI version](https://badge.fury.io/py/falkordb.svg)](https://badge.fury.io/py/falkordb)\n[![Codecov](https://codecov.io/gh/falkordb/falkordb-py/branch/main/graph/badge.svg)](https://codecov.io/gh/falkordb/falkordb-py)\n\n[![Forum](https://img.shields.io/badge/Forum-falkordb-blue)](https://github.com/orgs/FalkorDB/discussions)\n[![Discord](https://img.shields.io/discord/1146782921294884966?style=flat-square)](https://discord.gg/ErBEqN9E)\n\nFalkorDB python client\n\nsee [docs](http://falkordb-py.readthedocs.io/)\n\n## Installation\n```sh\npip install FalkorDB\n```\n\n## Usage\n\n### Run FalkorDB instance\nDocker:\n```sh\ndocker run --rm -p 6379:6379 falkordb/falkordb\n```\nOr use our [sandbox](https://cloud.falkordb.com/sandbox)\n\n### Example \n```python\nfrom falkordb import FalkorDB\n\n# Connect to FalkorDB\ndb = FalkorDB(host='localhost', port=6379)\n\n# Select the social graph\ng = db.select_graph('social')\n\n# Create 100 nodes and return a handful\nnodes = g.query('UNWIND range(0, 100) AS i CREATE (n {v:1}) RETURN n LIMIT 10').result_set\nfor n in nodes:\n print(n)\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Python client for interacting with FalkorDB database",
"version": "1.0.2",
"project_urls": {
"Homepage": "http://falkordb-py.readthedocs.io",
"Repository": "http://github.com/falkorDB/falkordb-py"
},
"split_keywords": [
"falkordb",
"graphdb",
"cypher"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6e815f4cdf7cb5f806d2686d3e089607bf245e316c87fa8dab08b2b08898ad77",
"md5": "0b3f6c62ee199c6e7d055c7f61ffa3ee",
"sha256": "d20641db7f41d0409c3e13adca2e3d65c1bcf5907be7065576db01f21ccf1a9b"
},
"downloads": -1,
"filename": "falkordb-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "0b3f6c62ee199c6e7d055c7f61ffa3ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 23878,
"upload_time": "2024-02-03T16:12:05",
"upload_time_iso_8601": "2024-02-03T16:12:05.315027Z",
"url": "https://files.pythonhosted.org/packages/6e/81/5f4cdf7cb5f806d2686d3e089607bf245e316c87fa8dab08b2b08898ad77/falkordb-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-03 16:12:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "falkorDB",
"github_project": "falkordb-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "falkordb"
}