tree: b8f57830c931124330d89b6d94a941e604b1bfa8 [path history] [tgz]
  1. graphar_pyspark/
  2. template/
  3. tests/
  4. .gitignore
  5. Makefile
  6. poetry.lock
  7. pyproject.toml
  8. README.md
pyspark/README.md

GraphAr PySpark (under development)

This directory contains the code and build system for the GraphAr PySpark library. Library is implemented as bindings to GraphAr Scala Spark library and does not contain any real logic.

Introduction

GraphAr PySpark project provides a PySpark API and utilities for working with GraphAr file format from PySpark. The project has the only python dependency -- pyspark itself. Currently only pysaprk~=3.2 is supported, but in the future the scope of supported versions will be extended.

Installation

Currently, the only way to install graphar_pyspark is to build it from the source code. The project is made with poetry, so it highly recommended to use this building system.

poetry install

It creates a tar.gz file in dist directory.

Generating API documentation

To generate API documentation, run the following command:

poetry install --with=docs
poetry run pdoc -t ./template --output-dir ./docs graphar_pyspark

The documentation will be generated in the docs directory.