-
Notifications
You must be signed in to change notification settings - Fork 13.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[FLINK-18937][python][doc] Add a Environemnt Setup section to the Installation document #13170
Conversation
Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community Automated ChecksLast 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
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 commandsThe @flinkbot bot supports the following commands:
|
d97160a
to
74263dc
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewing one more. Thanks for working on the Python docs!
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 %} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 %} |
$ 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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
|
||
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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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: |
@morsapaes Thanks a lot for your review. I have addressed the comments at the latest |
2b3d5bf
to
0e95592
Compare
5260d77
to
a17545a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@HuangXingBo Thanks a lot for the PR and thanks @morsapaes for the great review. Merging...
What is the purpose of the change
This pull request will add a Environment Setup section to the Installation document
Brief change log
Verifying this change
execute the script build_docs.sh
Does this pull request potentially affect one of the following parts:
@Public(Evolving)
: (no)Documentation