pathway README

The project's README from github.com/pathwaycom/pathway. As one markdown file: README.md.



pathwaycom%2Fpathway | Trendshift

ubuntu
Last release PyPI version PyPI downloads License: BSL
chat on Discord follow on Twitter follow on LinkedIn Awesome Python Pathway Guru
Getting Started | Deployment | Documentation and Support | Blog | License

Pathway Live Data Framework

Pathway Live Data Framework is a Python ETL framework for stream processing, real-time analytics, LLM pipelines, and RAG.

Pathway Live Data Framework comes with an easy-to-use Python API, allowing you to seamlessly integrate your favorite Python ML libraries. Pathway Live Data Framework code is versatile and robust: you can use it in both development and production environments, handling both batch and streaming data effectively. The same code can be used for local development, CI/CD tests, running batch jobs, handling stream replays, and processing data streams.

Pathway Live Data Framework is powered by a scalable Rust engine based on Differential Dataflow and performs incremental computation. Your Pathway Live Data Framework code, despite being written in Python, is run by the Rust engine, enabling multithreading, multiprocessing, and distributed computations. All the pipeline is kept in memory and can be easily deployed with Docker and Kubernetes.

You can install Pathway Live Data Framework with pip:

pip install -U pathway

For any questions, you will find the community and team behind the project on Discord.

Use-cases and templates

Ready to see what Pathway Live Data Framework can do?

Try one of our easy-to-run examples!

Available in both notebook and docker formats, these ready-to-launch examples can be launched in just a few clicks. Pick one and start your hands-on experience with Pathway Live Data Framework today!

Event processing and real-time analytics pipelines

With its unified engine for batch and streaming and its full Python compatibility, Pathway Live Data Framework makes data processing as easy as possible. It's the ideal solution for a wide range of data processing pipelines, including:

AI Pipelines

Pathway Live Data Framework provides dedicated LLM tooling to build live LLM and RAG pipelines. Wrappers for most common LLM services and utilities are included, making working with LLMs and RAGs pipelines incredibly easy. Check out our LLM xpack documentation.

Don't hesitate to try one of our runnable examples featuring LLM tooling. You can find such examples here.

Features

Getting started

Installation

Pathway Live Data Framework requires Python 3.10 or above.

You can install the current release of Pathway Live Data Framework using pip:

$ pip install -U pathway

⚠️ Pathway Live Data Framework is available on MacOS and Linux. Users of other systems should run Pathway Live Data Framework on a Virtual Machine.

Example: computing the sum of positive values in real time.

import pathway as pw

# Define the schema of your data (Optional)
class InputSchema(pw.Schema):
  value: int

# Connect to your data using connectors
input_table = pw.io.csv.read(
  "./input/",
  schema=InputSchema
)

#Define your operations on the data
filtered_table = input_table.filter(input_table.value>=0)
result_table = filtered_table.reduce(
  sum_value = pw.reducers.sum(filtered_table.value)
)

# Load your results to external systems
pw.io.jsonlines.write(result_table, "output.jsonl")

# Run the computation
pw.run()

Run Pathway Live Data Framework in Google Colab.

You can find more examples here.

Deployment

Locally

To use Pathway Live Data Framework, you only need to import it:

import pathway as pw

Now, you can easily create your processing pipeline, and let Pathway Live Data Framework handle the updates. Once your pipeline is created, you can launch the computation on streaming data with a one-line command:

pw.run()

You can then run your Pathway Live Data Framework project (say, main.py) just like a normal Python script: $ python main.py. Pathway Live Data Framework comes with a monitoring dashboard that allows you to keep track of the number of messages sent by each connector and the latency of the system. The dashboard also includes log messages.

Pathway Live Data Framework dashboard

Alternatively, you can use the pathway'ish version:

$ pathway spawn python main.py

Pathway Live Data Framework natively supports multithreading. To launch your application with 3 threads, you can do as follows:

$ pathway spawn --threads 3 python main.py

To jumpstart a Pathway Live Data Framework project, you can use our cookiecutter template.

Docker

You can easily run Pathway Live Data Framework using docker.

Pathway Live Data Framework image

You can use the Pathway Live Data Framework docker image, using a Dockerfile:

FROM pathwaycom/pathway:latest

WORKDIR /app

COPY requirements.txt ./
RUN pip install --no-cache-dir -r requirements.txt

COPY . .

CMD [ "python", "./your-script.py" ]

You can then build and run the Docker image:

docker build -t my-pathway-app .
docker run -it --rm --name my-pathway-app my-pathway-app

Run a single Python script

When dealing with single-file projects, creating a full-fledged Dockerfile might seem unnecessary. In such scenarios, you can execute a Python script directly using the Pathway Live Data Framework Docker image. For example:

docker run -it --rm --name my-pathway-app -v "$PWD":/app pathwaycom/pathway:latest python my-pathway-app.py

Python docker image

You can also use a standard Python image and install Pathway Live Data Framework using pip with a Dockerfile:

FROM --platform=linux/x86_64 python:3.10

RUN pip install -U pathway
COPY ./pathway-script.py pathway-script.py

CMD ["python", "-u", "pathway-script.py"]

Kubernetes and cloud

Docker containers are ideally suited for deployment on the cloud with Kubernetes. If you want to scale your Pathway Live Data Framework application, you may be interested in our Pathway Live Data Framework for Enterprise. Pathway Live Data Framework for Enterprise is specially tailored towards end-to-end data processing and real time intelligent analytics. It scales using distributed computing on the cloud and supports distributed Kubernetes deployment, with external persistence setup.

You can easily deploy Pathway Live Data Framework using services like Render: see how to deploy Pathway Live Data Framework in a few clicks.

If you are interested, don't hesitate to contact us to learn more.

Performance

Pathway Live Data Framework is made to outperform state-of-the-art technologies designed for streaming and batch data processing tasks, including: Flink, Spark, and Kafka Streaming. It also makes it possible to implement a lot of algorithms/UDF's in streaming mode which are not readily supported by other streaming frameworks (especially: temporal joins, iterative graph algorithms, machine learning routines).

If you are curious, here are some benchmarks to play with.

WordCount Graph

Documentation and Support

The entire documentation of Pathway Live Data Framework is available at pathway.com/developers/, including the API Docs.

If you have any question, don't hesitate to open an issue on GitHub, join us on Discord, or send us an email at [email protected].

We build cutting-edge data processing pipelines and co-promote solutions that push the boundaries of what's possible with Python and streaming data. Meet the people helping us shape the future of data engineering.

Project Description
Databento A simpler, faster way to get market data.
LangChain LangChain is the platform for agent engineering.
LlamaIndex The developer-trusted framework for building context-aware AI agents.
MinIO MinIO is a high-performance, S3 compatible object store, open sourced under GNU AGPLv3 license.
PaddleOCR PaddleOCR is an industry-leading, production-ready OCR and document AI engine, offering end-to-end solutions from text extraction to intelligent document understanding.
Redpanda Build, operate, and govern streaming and AI applications without the complexity of Kafka.

License

Pathway Live Data Framework is distributed on a BSL 1.1 License which allows for unlimited non-commercial use, as well as use of the Pathway Live Data Framework package for most commercial purposes, free of charge. Code in this repository automatically converts to Open Source (Apache 2.0 License) after 4 years. Some public repos which are complementary to this one (examples, libraries, connectors, etc.) are licensed as Open Source, under the MIT license.

Contribution guidelines

If you develop a library or connector which you would like to integrate with this repo, we suggest releasing it first as a separate repo on a MIT/Apache 2.0 license.

For all concerns regarding core Pathway Live Data Framework functionalities, Issues are encouraged. For further information, don't hesitate to engage with Pathway's Discord community.

pathway (pathwaycom/pathway)

Searching Database…

62.1K ·GitHub
这是什么?Pathway 是一个用于流处理、实时分析、LLM 流水线和 RAG 的 Python ETL 框架,同一套代码既可用于批处理作业、CI/CD 测试,也可用于实时数据流。
它是 Python 库,还是自带执行引擎?你用 Python 编写代码,但流水线实际运行在基于 Differential Dataflow 的可扩展 Rust 引擎上,正是它提供了多线程、多进程和分布式计算能力。
流水线要怎么跑起来?用 pip 安装,导入 pathway,定义你的流水线,然后用一行运行命令启动计算,再像运行普通脚本一样执行它(python main.py)。
我需要哪个 Python 版本?Pathway 需要 Python 3.10 或更高版本。
它能在 Windows 上运行吗?不能——仅支持 MacOS 和 Linux;Windows 用户需要在虚拟机中运行。
它能连接哪些数据源?内置连接器支持 Kafka、Google Drive、PostgreSQL 和 SharePoint,其 Airbyte 连接器可将支持范围扩展到 300 多个数据源;你也可以编写自定义连接器。
针对 LLM 和 RAG 场景提供了哪些功能?LLM 扩展提供了封装器、解析器、嵌入器和切分器,以及内存中的实时向量索引(Vector Index),并集成了 LangChain 和 LlamaIndex,用于构建实时 RAG 应用。
它如何处理迟到或乱序的数据?Pathway 会在内部跟踪时间,每当有新数据或迟到数据到达时更新结果;免费版保证“至少一次”一致性,企业版则保证“恰好一次”一致性。
它的性能与 Flink 或 Spark 相比如何?README 中表示,Pathway 的设计目标是超越 Flink、Spark 和 Kafka Streaming,并且它支持时态连接(temporal joins)、迭代图算法等其他流处理框架不容易处理的算法。
Creator
pathwaycom
Size
178.7 MB
Stars
62.1K
Age
3y
Commits · 90 Days