Metadata-Version: 2.1
Name: spark-connect-proxy
Version: 0.0.5
Summary: A reverse proxy server which allows secure connectivity to a Spark Connect server
Author-email: Philip Moore <prmoore77@hotmail.com>
Project-URL: Homepage, https://github.com/prmoore77/spark-connect-proxy
Keywords: spark,pyspark,grpc,reverse-proxy,connect,spark-connect
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: click==8.1.*
Requires-Dist: pyspark==3.5.1
Requires-Dist: grpcio-tools==1.66.*
Requires-Dist: grpcio-channelz==1.66.*
Requires-Dist: grpcio-status==1.66.*
Requires-Dist: pyjwt==2.9.*
Requires-Dist: python-dotenv==1.0.*
Requires-Dist: pyarrow_hotfix==0.6.*
Requires-Dist: protobuf==5.27.2
Requires-Dist: pyOpenSSL==24.2.1
Provides-Extra: dev
Requires-Dist: bumpver; extra == "dev"
Requires-Dist: pip-tools; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Provides-Extra: client
Requires-Dist: ibis-framework==9.5.*; extra == "client"
Requires-Dist: codetiming==1.4.*; extra == "client"
Requires-Dist: pandas==2.2.*; extra == "client"
Requires-Dist: pyarrow==17.0.*; extra == "client"

# spark-connect-proxy
A reverse proxy server which allows secure connectivity to a Spark Connect server

[<img src="https://img.shields.io/badge/GitHub-prmoore77%2Fspark--connect--proxy-blue.svg?logo=Github">](https://github.com/prmoore77/spark-connect-proxy)
[![spark-connect-proxy-ci](https://github.com/prmoore77/spark-connect-proxy/actions/workflows/ci.yml/badge.svg)](https://github.com/prmoore77/spark-connect-proxy/actions/workflows/ci.yml)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/spark-connect-proxy)](https://pypi.org/project/spark-connect-proxy/)
[![PyPI version](https://badge.fury.io/py/spark-connect-proxy.svg)](https://badge.fury.io/py/spark-connect-proxy)
[![PyPI Downloads](https://img.shields.io/pypi/dm/spark-connect-proxy.svg)](https://pypi.org/project/spark-connect-proxy/)

# Setup (to run locally)

## Install package
You can install `spark-connect-proxy` from PyPi or from source.

### Option 1 - from PyPi
```shell
# Create the virtual environment
python3 -m venv .venv

# Activate the virtual environment
. .venv/bin/activate

pip install spark-connect-proxy
```

### Option 2 - from source - for development
```shell
git clone https://github.com/prmoore77/spark-connect-proxy

cd spark-connect-proxy

# Create the virtual environment
python3 -m venv .venv

# Activate the virtual environment
. .venv/bin/activate

# Upgrade pip, setuptools, and wheel
pip install --upgrade pip setuptools wheel

# Install Spark Connect Proxy - in editable mode with client and dev dependencies
pip install --editable .[client,dev]
```

### Note
For the following commands - if you running from source and using `--editable` mode (for development purposes) - you will need to set the PYTHONPATH environment variable as follows:
```shell
export PYTHONPATH=$(pwd)/src
```

### Usage
TODO

### Handy development commands

#### Version management

##### Bump the version of the application - (you must have installed from source with the [dev] extras)
```bash
bumpver update --patch
```
