[FLINK-18937][python][doc] Add a Environemnt Setup section to the Installation document #13170

HuangXingBo · 2020-08-17T08:42:27Z

What is the purpose of the change

This pull request will add a Environment Setup section to the Installation document

Brief change log

Add a Environment Setup section in installation.md and installation.zh.md

Verifying this change

execute the script build_docs.sh

Does this pull request potentially affect one of the following parts:

Dependencies (does it add or upgrade a dependency): (no)
The public API, i.e., is any changed class annotated with @Public(Evolving): (no)
The serializers: (no)
The runtime per-record code paths (performance sensitive): (no)
Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: (no)
The S3 file system connector: (no)

Documentation

Does this pull request introduce a new feature? (no)
If yes, how is the feature documented? (not applicable)

flinkbot · 2020-08-17T08:45:21Z

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit 0e95592 (Fri Oct 16 10:57:15 UTC 2020)

✅no warnings

_{Mention the bot in a comment to re-run the automated checks.}

Review Progress

❓ 1. The [description] looks good.
❓ 2. There is [consensus] that the contribution should go into to Flink.
❓ 3. Needs [attention] from.
❓ 4. The change fits into the overall [architecture].
❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.

The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
@flinkbot approve all to approve all aspects
@flinkbot approve-until architecture to approve everything until architecture
@flinkbot attention @username1 [@username2 ..] to require somebody's attention
@flinkbot disapprove architecture to remove an approval you gave earlier

flinkbot · 2020-08-17T09:04:30Z

CI report:

0e95592 Azure: SUCCESS
a17545a Azure: PENDING

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot run travis re-run the last Travis build
@flinkbot run azure re-run the last Azure build

morsapaes

Reviewing one more. Thanks for working on the Python docs!

morsapaes · 2020-08-26T11:58:14Z

docs/dev/python/getting-started/installation.md

+Your system may include multiple python versions and thus also include multiple python binary executables. You can run the following
+`ls` command to find out what python binary executables are available on your system:
+{% highlight bash %}


Suggested change

Your system may include multiple python versions and thus also include multiple python binary executables. You can run the following

`ls` command to find out what python binary executables are available on your system:

{% highlight bash %}

Your system may include multiple Python versions, and thus also include multiple Python binary executables. You can run the following

`ls` command to find out what Python binary executables are available in your system:

{% highlight bash %}

morsapaes · 2020-08-26T11:59:50Z

docs/dev/python/getting-started/installation.md

+$ ls /usr/bin/python*
+{% endhighlight %}
+
+For satisfying the the version of python environment, you can choose to soft link `python` to point to your python3 interpreter:


Suggested change

For satisfying the the version of python environment, you can choose to soft link `python` to point to your python3 interpreter:

To satisfy the PyFlink requirement regarding the Python environment version, you can choose to soft link `python` to point to your `python3` interpreter:

morsapaes · 2020-08-26T12:02:35Z

docs/dev/python/getting-started/installation.md

+In addition to the way of soft link, you can also choose to create a virtual env of Python.
+For details on the creating of virtual env, you can refer to the [Preparing Python Virtual Environment]({{ site.baseurl }}/dev/python/faq.html#preparing-python-virtual-environment)


Suggested change

In addition to the way of soft link, you can also choose to create a virtual env of Python.

For details on the creating of virtual env, you can refer to the [Preparing Python Virtual Environment]({{ site.baseurl }}/dev/python/faq.html#preparing-python-virtual-environment)

In addition to creating a soft link, you can also choose to create a Python virtual environment (`venv`). You can refer to the [Preparing Python Virtual Environment]({{ site.baseurl }}/dev/python/faq.html#preparing-python-virtual-environment) documentation page for details on how to achieve that setup.

morsapaes · 2020-08-26T12:04:21Z

docs/dev/python/getting-started/installation.md

+
+In addition to the way of soft link, you can also choose to create a virtual env of Python.
+For details on the creating of virtual env, you can refer to the [Preparing Python Virtual Environment]({{ site.baseurl }}/dev/python/faq.html#preparing-python-virtual-environment)
+
 ## Installation of PyFlink

 PyFlink has already been deployed to PyPi and can be installed as following:


Suggested change

PyFlink has already been deployed to PyPi and can be installed as following:

PyFlink is available through [PyPi](https://pypi.org/project/apache-flink/) as a regular Python package and can be installed as follows:

HuangXingBo · 2020-08-27T07:49:14Z

@morsapaes Thanks a lot for your review. I have addressed the comments at the latest fix-comments-1 commit

…tallation document

dianfu

@HuangXingBo Thanks a lot for the PR and thanks @morsapaes for the great review. Merging...

rmetzger added the review=description? label Aug 17, 2020

rmetzger added component=API/Python component=Documentation labels Aug 17, 2020

HuangXingBo force-pushed the FLINK-18937 branch from d97160a to 74263dc Compare August 20, 2020 03:33

morsapaes reviewed Aug 26, 2020

View reviewed changes

HuangXingBo added 2 commits October 16, 2020 14:50

[FLINK-18937][python][doc] Add a Environemnt Setup section to the Ins…

1d7d638

…tallation document

fix-comments-1

0e95592

HuangXingBo force-pushed the FLINK-18937 branch from 2b3d5bf to 0e95592 Compare October 16, 2020 06:57

add configure way to specify python interpreter

a17545a

HuangXingBo force-pushed the FLINK-18937 branch from 5260d77 to a17545a Compare October 19, 2020 03:43

dianfu approved these changes Oct 19, 2020

View reviewed changes

dianfu merged commit 2f6c0eb into apache:master Oct 19, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FLINK-18937][python][doc] Add a Environemnt Setup section to the Installation document #13170

[FLINK-18937][python][doc] Add a Environemnt Setup section to the Installation document #13170

HuangXingBo commented Aug 17, 2020

flinkbot commented Aug 17, 2020 •

edited

flinkbot commented Aug 17, 2020 •

edited

morsapaes left a comment

morsapaes Aug 26, 2020

morsapaes Aug 26, 2020

morsapaes Aug 26, 2020

morsapaes Aug 26, 2020

HuangXingBo commented Aug 27, 2020

dianfu left a comment

	For satisfying the the version of python environment, you can choose to soft link `python` to point to your python3 interpreter:
	To satisfy the PyFlink requirement regarding the Python environment version, you can choose to soft link `python` to point to your `python3` interpreter:

		In addition to the way of soft link, you can also choose to create a virtual env of Python.
		For details on the creating of virtual env, you can refer to the [Preparing Python Virtual Environment]({{ site.baseurl }}/dev/python/faq.html#preparing-python-virtual-environment)

	In addition to the way of soft link, you can also choose to create a virtual env of Python.
	For details on the creating of virtual env, you can refer to the [Preparing Python Virtual Environment]({{ site.baseurl }}/dev/python/faq.html#preparing-python-virtual-environment)
	In addition to creating a soft link, you can also choose to create a Python virtual environment (`venv`). You can refer to the [Preparing Python Virtual Environment]({{ site.baseurl }}/dev/python/faq.html#preparing-python-virtual-environment) documentation page for details on how to achieve that setup.

	PyFlink has already been deployed to PyPi and can be installed as following:
	PyFlink is available through [PyPi](https://pypi.org/project/apache-flink/) as a regular Python package and can be installed as follows:

[FLINK-18937][python][doc] Add a Environemnt Setup section to the Installation document #13170

[FLINK-18937][python][doc] Add a Environemnt Setup section to the Installation document #13170

Conversation

HuangXingBo commented Aug 17, 2020

What is the purpose of the change

Brief change log

Verifying this change

Does this pull request potentially affect one of the following parts:

Documentation

flinkbot commented Aug 17, 2020 • edited

Automated Checks

Review Progress

flinkbot commented Aug 17, 2020 • edited

CI report:

morsapaes left a comment

Choose a reason for hiding this comment

morsapaes Aug 26, 2020

Choose a reason for hiding this comment

morsapaes Aug 26, 2020

Choose a reason for hiding this comment

morsapaes Aug 26, 2020

Choose a reason for hiding this comment

morsapaes Aug 26, 2020

Choose a reason for hiding this comment

HuangXingBo commented Aug 27, 2020

dianfu left a comment

Choose a reason for hiding this comment

flinkbot commented Aug 17, 2020 •

edited

flinkbot commented Aug 17, 2020 •

edited