Metadata-Version: 2.3
Name: graphframes-py
Version: 0.9.3
Summary: GraphFrames: Graph Processing Framework for Apache Spark
License: Apache 2.0
Keywords: pyspark,network-analysis,pagerank,pregel,graph
Author: GraphFrames Contributors
Author-email: graphframes@googlegroups.com
Maintainer: Russell Jurney
Maintainer-email: russell.jurney@gmail.com
Requires-Python: >=3.10
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Database :: Front-Ends
Classifier: Topic :: Scientific/Engineering
Requires-Dist: nose (==1.3.7)
Requires-Dist: numpy (>=1.7)
Project-URL: Bug Tracker, https://github.com/graphframes/graphframes/issues
Project-URL: Code Repository, https://github.com/graphframes/graphframes
Project-URL: Project Homepage, https://graphframes.github.io/graphframes
Project-URL: PyPi Homepage, https://pypi.org/project/graphframes-py
Description-Content-Type: text/markdown

# GraphFrames Python Package

![PyPI - Downloads](https://img.shields.io/pypi/dm/graphframes-py) ![PyPI - License](https://img.shields.io/pypi/l/graphframes-py) ![PyPI - Version](https://img.shields.io/pypi/v/graphframes-py)

<img src=https://raw.githubusercontent.com/graphframes/graphframes/refs/heads/master/docs/img/GraphFrames-Logo-Large.png width=500>

https://graphframes.io/

The is the officila [graphframes-py PyPI package](https://pypi.org/project/graphframes-py/), which is a Python wrapper for the Scala GraphFrames library.
This package is maintained by the GraphFrames project and is available on PyPI.

For instructions on GraphFrames, check the project [README.md](https://github.com/graphframes/graphframes?tab=readme-ov-file#graphframes-dataframe-based-graphs).

See [Installation and Quick-Start](https://github.com/graphframes/graphframes?tab=readme-ov-file#installation-and-quick-start) for the best way to install and use GraphFrames.

## Installation

```bash
pip install graphframes-py
```

**NOTE!** *Python distribution does not include JVM-core. You need to add it to your cluster or Spark-Connect server!*

## Running `graphframes-py`

You should use GraphFrames via the `--packages` argument to `pyspark` or `spark-submit`, but this package is helpful in development environments.

```bash
# Interactive Python, Spark 3.5.x
$ pyspark --packages io.graphframes:graphframes-spark3_2.12:0.9.2

# Interactive Python, Spark 4.0.x
$ pyspark --packages io.graphframes:graphframes-spark4_2.13:0.9.2
```

## Documentation

- [API Reference](https://graphframes.io/api/python/index.html)

## Spark-Connect Note

GraphFrames PySpark is choosing connect or classic implementation implicitly based on the result of `is_remote()`.
To enforce usage of connect-based implementation, you may export this variable `SPARK_CONNECT_MODE_ENABLED=1`

