# pyTigerGraph
pyTigerGraph is a Python package for connecting to TigerGraph databases. Check out the documentation [here](https://docs.tigergraph.com/pytigergraph/current/intro/).
[](https://pepy.tech/project/pyTigergraph)
[](https://pepy.tech/project/pyTigergraph)
[](https://pepy.tech/project/pyTigergraph)
## Quickstart
### Installing pyTigerGraph
This section walks you through installing pyTigerGraph on your machine.
#### Prerequisites
* Python 3+
* If you wish to use the GDS functionality, install `torch` ahead of time.
#### Install _pyTigerGraph_
To download _pyTigerGraph_, run the following command in the command line or use the appropriate tool of your development environment (anaconda, PyCharm, etc.).:
```sh
pip3 install pyTigerGraph
```
#### Install _pyTigerGraph[gds]_
To utilize the Graph Data Science Functionality, there are a few options:
* To use the GDS functions with **PyTorch Geometric**, install `torch` and `PyTorch Geometric` according to their instructions:
1) [Install Torch](https://pytorch.org/get-started/locally/)
2) [Install PyTorch Geometric](https://pytorch-geometric.readthedocs.io/en/latest/notes/installation.html)
3) Install pyTigerGraph with:
```sh
pip3 install 'pyTigerGraph[gds]'
```
* To use the GDS functions with **DGL**, install `torch` and `dgl` according to their instructions:
1) [Install Torch](https://pytorch.org/get-started/locally/)
2) [Install DGL](https://www.dgl.ai/pages/start.html)
3) Install pyTigerGraph with:
```sh
pip3 install 'pyTigerGraph[gds]'
```
* To use the GDS functions without needing to produce output in the format supported by PyTorch Geometric or DGL.
This makes the data loaders output *Pandas dataframes*:
```sh
pip3 install 'pyTigerGraph[gds]'
```
Once the package is installed, you can import it like any other Python package:
```py
import pyTigerGraph as tg
```
### Getting Started with Core Functions
[](https://www.youtube.com/watch?v=2BcC3C-qfX4)
The video above is a good starting place for learning the core functions of pyTigerGraph. [This Google Colab notebook](https://colab.research.google.com/drive/1JhYcnGVWT51KswcXZzyPzKqCoPP5htcC) is the companion notebook to the video.
Raw data
{
"_id": null,
"home_page": "https://docs.tigergraph.com/pytigergraph/current/intro/",
"name": "pyTigerGraph",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "TigerGraph, Graph Database, Data Science, Machine Learning",
"author": "TigerGraph Inc.",
"author_email": "support@tigergraph.com",
"download_url": "https://files.pythonhosted.org/packages/e4/3d/4ba18a49655ed8dfd6040eae59cd8100f5d531e8a1d457685454fba54922/pytigergraph-1.6.1.tar.gz",
"platform": null,
"description": "# pyTigerGraph\n\npyTigerGraph is a Python package for connecting to TigerGraph databases. Check out the documentation [here](https://docs.tigergraph.com/pytigergraph/current/intro/).\n\n[](https://pepy.tech/project/pyTigergraph)\n[](https://pepy.tech/project/pyTigergraph)\n[](https://pepy.tech/project/pyTigergraph)\n\n## Quickstart\n\n### Installing pyTigerGraph\nThis section walks you through installing pyTigerGraph on your machine.\n\n#### Prerequisites\n* Python 3+\n* If you wish to use the GDS functionality, install `torch` ahead of time.\n\n#### Install _pyTigerGraph_\n\nTo download _pyTigerGraph_, run the following command in the command line or use the appropriate tool of your development environment (anaconda, PyCharm, etc.).:\n\n```sh\npip3 install pyTigerGraph\n```\n\n#### Install _pyTigerGraph[gds]_\n\nTo utilize the Graph Data Science Functionality, there are a few options:\n* To use the GDS functions with **PyTorch Geometric**, install `torch` and `PyTorch Geometric` according to their instructions:\n\n 1) [Install Torch](https://pytorch.org/get-started/locally/)\n\n 2) [Install PyTorch Geometric](https://pytorch-geometric.readthedocs.io/en/latest/notes/installation.html)\n\n 3) Install pyTigerGraph with:\n ```sh\n pip3 install 'pyTigerGraph[gds]'\n ```\n\n* To use the GDS functions with **DGL**, install `torch` and `dgl` according to their instructions:\n\n 1) [Install Torch](https://pytorch.org/get-started/locally/)\n\n 2) [Install DGL](https://www.dgl.ai/pages/start.html)\n\n 3) Install pyTigerGraph with:\n ```sh\n pip3 install 'pyTigerGraph[gds]'\n ```\n\n* To use the GDS functions without needing to produce output in the format supported by PyTorch Geometric or DGL.\nThis makes the data loaders output *Pandas dataframes*:\n```sh\npip3 install 'pyTigerGraph[gds]'\n```\n\nOnce the package is installed, you can import it like any other Python package:\n\n```py\nimport pyTigerGraph as tg\n```\n### Getting Started with Core Functions\n\n[](https://www.youtube.com/watch?v=2BcC3C-qfX4)\n\nThe video above is a good starting place for learning the core functions of pyTigerGraph. [This Google Colab notebook](https://colab.research.google.com/drive/1JhYcnGVWT51KswcXZzyPzKqCoPP5htcC) is the companion notebook to the video.\n",
"bugtrack_url": null,
"license": "Apache 2",
"summary": "Library to connect to TigerGraph databases",
"version": "1.6.1",
"project_urls": {
"Bug Reports": "https://github.com/tigergraph/pyTigerGraph/issues",
"Homepage": "https://docs.tigergraph.com/pytigergraph/current/intro/",
"Source": "https://github.com/tigergraph/pyTigerGraph"
},
"split_keywords": [
"tigergraph",
" graph database",
" data science",
" machine learning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "39c7ef71fb8081d76f9e5587562aed3108c1508c13e6ee83995592fe76d8acfe",
"md5": "d615862be858406c355de3271f6f1a98",
"sha256": "c689d941615a0dd2f02a688d2651570ab03273f9c6957783ba298b6bfb3c3315"
},
"downloads": -1,
"filename": "pyTigerGraph-1.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d615862be858406c355de3271f6f1a98",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 267083,
"upload_time": "2024-04-25T19:55:52",
"upload_time_iso_8601": "2024-04-25T19:55:52.080107Z",
"url": "https://files.pythonhosted.org/packages/39/c7/ef71fb8081d76f9e5587562aed3108c1508c13e6ee83995592fe76d8acfe/pyTigerGraph-1.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e43d4ba18a49655ed8dfd6040eae59cd8100f5d531e8a1d457685454fba54922",
"md5": "964c59314dbcc3b536ff9a6cee6463fa",
"sha256": "c5bf851c7adfa577afd22c04e9f439f9dde7b787c3451d2cc3c324c50b8d0162"
},
"downloads": -1,
"filename": "pytigergraph-1.6.1.tar.gz",
"has_sig": false,
"md5_digest": "964c59314dbcc3b536ff9a6cee6463fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 219035,
"upload_time": "2024-04-25T19:55:55",
"upload_time_iso_8601": "2024-04-25T19:55:55.337420Z",
"url": "https://files.pythonhosted.org/packages/e4/3d/4ba18a49655ed8dfd6040eae59cd8100f5d531e8a1d457685454fba54922/pytigergraph-1.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-25 19:55:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tigergraph",
"github_project": "pyTigerGraph",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pytigergraph"
}
JSON
