dianfu commented on a change in pull request #8992: [FLINK-12723][docs] setup IDE for Python URL: https://github.com/apache/flink/pull/8992#discussion_r300529302
########## File path: docs/flinkDev/ide_setup.md ########## @@ -125,4 +125,31 @@ due to version incompatibilities with the bundled Scala version in Scala IDE 4.4 **We recommend to use IntelliJ instead (see [above](#intellij-idea))** +## PyCharm + +A brief guide on how to set up PyCharm for development of the flink-python module. + +The following documentation describes the steps to setup PyCharm +([https://www.jetbrains.com/pycharm/download/](https://www.jetbrains.com/pycharm/download/)) +with the Flink Python sources. + +### Importing flink-python + +1. Start PyCharm and choose "Open" +2. Select the flink-python folder in the cloned Flink repository + +### Checkstyle For Python +The Python code of Apache Flink should create a flake8 external tool in the project. + +1. Install the flake8 in the used Python interpreter(refer to ([https://pypi.org/project/flake8/](https://pypi.org/project/flake8/)). +2. Selecting "Settings -> Tools -> External Tools -> +", Next configuring the external tool. +3. Set the “Name” to “flake8”. Review comment: The double quotes should be in English ---------------------------------------------------------------- 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
