hequn8128 commented on a change in pull request #11079: [FLINK-16031][python] Improve the description in the README file of PyFlink 1.9.x. URL: https://github.com/apache/flink/pull/11079#discussion_r383130950
########## File path: 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(currently version 2.8.0). Review comment: We have not specified the version of python-dateutil in setup.py, so the version should be latest, instead of 2.8.0? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
