Feldera Python SDK
The feldera Python package is the Python client for the Feldera HTTP API.
The Python SDK documentation is available at: https://docs.feldera.com/python
Getting started
Installation
uv pip install feldera
Example usage
The Python client interacts with the API server of the Feldera instance.
# File: example.py
from feldera import FelderaClient, PipelineBuilder, Pipeline
# Instantiate client
client = FelderaClient() # Default: http://localhost:8080 without authentication
# client = FelderaClient(url="https://localhost:8080", api_key="apikey:...", requests_verify="/path/to/tls.crt")
# (Re)create pipeline
name = "example"
sql = """
CREATE TABLE t1 (i1 INT) WITH ('materialized' = 'true');
CREATE MATERIALIZED VIEW v1 AS SELECT * FROM t1;
"""
print("(Re)creating pipeline...")
pipeline = PipelineBuilder(client, name, sql).create_or_replace()
pipeline.start()
print(f"Pipeline status: {pipeline.status()}")
pipeline.pause()
print(f"Pipeline status: {pipeline.status()}")
pipeline.stop(force=True)
# Find existing pipeline
pipeline = Pipeline.get(name, client)
pipeline.start()
print(f"Pipeline status: {pipeline.status()}")
pipeline.stop(force=True)
pipeline.clear_storage()
Run using:
uv run python example.py
Environment variables
Some default parameter values in the Python SDK can be overridden via environment variables.
Environment variables for FelderaClient(...)
export FELDERA_HOST="https://localhost:8080" # Overrides default for `url`
export FELDERA_API_KEY="apikey:..." # Overrides default for `api_key`
# The following together override default for `requests_verify`
# export FELDERA_TLS_INSECURE="false" # If set to "1", "true" or "yes" (all case-insensitive), disables TLS certificate verification
# export FELDERA_HTTPS_TLS_CERT="/path/to/tls.crt" # Custom TLS certificate
Environment variables for PipelineBuilder(...)
export FELDERA_RUNTIME_VERSION="..." # Overrides default for `runtime_version`
Development
Development assumes you have cloned the Feldera code repository.
Installation
cd python
# Optional: create and activate virtual environment if you don't have one
uv venv
source .venv/bin/activate
# Install in editable mode
uv pip install -e .
Formatting
Formatting requires the ruff package: uv pip install ruff
cd python
ruff check
ruff format
Tests
Running the test requires the pytest package: uv pip install pytest
# All tests
cd python
uv run python -m pytest tests/
# Specific tests directory
uv run python -m pytest tests/platform/
# Specific test file
uv run python -m pytest tests/platform/test_pipeline_crud.py
# Specific test
uv run python -m pytest tests/platform/test_pipeline_crud.py::test_pipeline_post
# Tip: add argument -x at the end for it to fail fast
# Tip: add argument -s at the end to show stdout/stderr
For further information about the tests, please see tests/README.md.
Documentation
Building documentation requires the sphinx package: uv pip install sphinx
cd python/docs
sphinx-apidoc -o . ../feldera
make html
make clean # Cleanup afterwards
Installation from GitHub
Latest main branch:
uv pip install git+https://github.com/feldera/feldera#subdirectory=python
Different branch (replace BRANCH_NAME):
uv pip install git+https://github.com/feldera/feldera@BRANCH_NAME#subdirectory=python
2 maintainers
Metadata
2 maintainers
Release files for feldera 0.364.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| feldera-0.364.0.tar.gz | 75.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| feldera-0.364.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 157.3 kB
Release files / feldera-0.364.0.tar.gz
| Download URL | feldera-0.364.0.tar.gz |
|---|---|
| Size | 75.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d2beca112bd8bd2a357141594cb2f09375d96554cd1057a7fbbe894c6d5a5913
|
|
BLAKE2b-256 checksum How to use checksums |
7c37da7e0a8053344f31da35cdf425875925bf6cc28a137b6f91996778955c10
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency logRelease files / feldera-0.364.0-py3-none-any.whl
| Download URL | feldera-0.364.0-py3-none-any.whl |
|---|---|
| Size | 82.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4e40ab97e5514060a8724e2175187ee09b389b24f2b475c6f3c3aab88a80be44
|
|
BLAKE2b-256 checksum How to use checksums |
786832398922f9816d7a1c5d0a8dd40499543c919953d4d0a4596ed9af9e3019
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.
Transparency log
