You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by he...@apache.org on 2020/02/24 09:51:10 UTC

[flink] branch release-1.9 updated: [FLINK-16031][python] Improve the description in the README file of PyFlink 1.9.x. (#11079)

This is an automated email from the ASF dual-hosted git repository.

hequn pushed a commit to branch release-1.9
in repository https://gitbox.apache.org/repos/asf/flink.git


The following commit(s) were added to refs/heads/release-1.9 by this push:
     new e4c45a3  [FLINK-16031][python] Improve the description in the README file of PyFlink 1.9.x. (#11079)
e4c45a3 is described below

commit e4c45a364e071e8f8176a1650873e5db6828ec1c
Author: Wei Zhong <we...@gmail.com>
AuthorDate: Mon Feb 24 17:50:50 2020 +0800

    [FLINK-16031][python] Improve the description in the README file of PyFlink 1.9.x. (#11079)
---
 flink-python/README.md | 29 +++++++++--------------------
 1 file changed, 9 insertions(+), 20 deletions(-)

diff --git a/flink-python/README.md b/flink-python/README.md
index a0117a0..7cf6b25 100644
--- a/flink-python/README.md
+++ b/flink-python/README.md
@@ -1,30 +1,19 @@
-# Apache Flink Python API
+# Apache Flink
 
-Apache Flink is an open source stream processing framework with the powerful stream- and batch-processing capabilities.
+Apache Flink is a framework and distributed processing engine for stateful computations over unbounded and bounded data streams. Flink has been designed to run in all common cluster environments, perform computations at in-memory speed and at any scale.
 
-Learn more about Flink at [http://flink.apache.org/](http://flink.apache.org/)
+Learn more about Flink at [https://flink.apache.org/](https://flink.apache.org/)
 
-This packaging allows you to write Flink programs in Python, but it is currently a very initial version and will change in future versions.
-
-In this initial version only Table API is supported, you can find the documentation at [https://ci.apache.org/projects/flink/flink-docs-master/dev/table/tableApi.html](https://ci.apache.org/projects/flink/flink-docs-master/dev/table/tableApi.html)
-
-## Installation
+## Python Packaging
 
-Currently, we can install PyFlink from Flink source code. Enter the directory where this README.md file is located and install PyFlink on your device by executing 
-
-```
-python setup.py install
-```
+This packaging allows you to write Flink programs in Python, but it is currently a very initial version and will change in future versions.
 
-## Running test cases 
+In this initial version only Table API is supported, you can find the documentation at [https://ci.apache.org/projects/flink/flink-docs-release-1.9/dev/table/tableApi.html](https://ci.apache.org/projects/flink/flink-docs-release-1.9/dev/table/tableApi.html)
 
-Currently, we use conda and tox to verify the compatibility of the Flink Python API for multiple versions of Python and will integrate some useful plugins with tox, such as flake8.
-We can enter the directory where this README.md file is located and run test cases by executing
+The tutorial can be found at [https://ci.apache.org/projects/flink/flink-docs-release-1.9/tutorials/python_table_api.html](https://ci.apache.org/projects/flink/flink-docs-release-1.9/tutorials/python_table_api.html)
 
-```
-./dev/lint-python.sh
-```
+The auto-generated Python docs can be found at [https://ci.apache.org/projects/flink/flink-docs-release-1.9/api/python/](https://ci.apache.org/projects/flink/flink-docs-release-1.9/api/python/)
 
 ## Python Requirements
 
-PyFlink depends on Py4J (currently version 0.10.8.1).
+Apache Flink Python API depends on Py4J (currently version 0.10.8.1) and python-dateutil (latest version is recommended).