[BEAM-3240] Improves development and testing instructions related to Python SDK by chamikaramj · Pull Request #253 · apache/beam-site

chamikaramj · 2017-05-26T00:16:51Z

Updates contribution guide to include development and testing instructions for Python SDK.

chamikaramj · 2017-05-26T00:17:29Z

asfbot · 2017-05-26T00:25:45Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Stage/510/

Jenkins built the site at commit id b9dd624 with Jekyll and staged it here. Happy reviewing.

Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again.

asfbot · 2017-05-26T00:37:15Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Stage/511/

Jenkins built the site at commit id 9bd446a with Jekyll and staged it here. Happy reviewing.

Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again.

aaltay

Thank you @chamikaramj

aaltay · 2017-05-26T01:17:36Z

src/contribute/contribution-guide.md

+
+For contributions to the Python code, you can use following commands to run unit tests locally and to check for lint errors. Once you send a pull request for review, these tests will be rerun using Jenkins. We recommend setting up a virtual environment before testing your code.
+
+##### Running a single test using nose


Should we add a section for testing with tox? (not just for lint)

Why is it needed ? If it simply another way to run tests I would rather avoid adding that info here.

aaltay · 2017-05-26T01:19:48Z

src/contribute/contribution-guide.md


+#### Python SDK
+
+For contributions to the Python code, you can use following commands to run unit tests locally and to check for lint errors. Once you send a pull request for review, these tests will be rerun using Jenkins. We recommend setting up a virtual environment before testing your code.


Maybe a TBD for people who wants to use mvn. FWIW mvn clean verify works in the python directory. It should work from the root with the right selection of project (mvn clean verify -pl sdks/python)

I think we should not add that info till https://issues.apache.org/jira/browse/BEAM-2341 and other issues around Maven+Python SDK are resolved.

I wonder if adding some information would help people coming from the mvn background. I am not sure, we can leave it as is.

Added instructions for running tests using Maven.

Don't follow -- which are "following commands"?

Fix above: Travis CI is disabled.
Overall, I'd probably generalize and say that mvn clean verify does it all, i.e., no Java SDK/Python SDK sections at all.

aaltay · 2017-05-26T01:20:40Z

src/contribute/contribution-guide.md


    $ mvn clean verify

+#### Python SDK


Should we say anything about cython? (probably not)

Added a sentence on Python under testing section.

chamikaramj

Thanks. PTAL.

chamikaramj · 2017-05-26T01:46:43Z

src/contribute/contribution-guide.md


    $ mvn clean verify

+#### Python SDK


Added a sentence on Python under testing section.

chamikaramj · 2017-05-26T02:24:01Z

src/contribute/contribution-guide.md


+#### Python SDK
+
+For contributions to the Python code, you can use following commands to run unit tests locally and to check for lint errors. Once you send a pull request for review, these tests will be rerun using Jenkins. We recommend setting up a virtual environment before testing your code.


I think we should not add that info till https://issues.apache.org/jira/browse/BEAM-2341 and other issues around Maven+Python SDK are resolved.

chamikaramj · 2017-05-26T02:25:04Z

src/contribute/contribution-guide.md

+
+For contributions to the Python code, you can use following commands to run unit tests locally and to check for lint errors. Once you send a pull request for review, these tests will be rerun using Jenkins. We recommend setting up a virtual environment before testing your code.
+
+##### Running a single test using nose


Why is it needed ? If it simply another way to run tests I would rather avoid adding that info here.

asfbot · 2017-05-26T02:37:35Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Stage/512/

Jenkins built the site at commit id 120a35f with Jekyll and staged it here. Happy reviewing.

Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again.

aaltay · 2017-05-26T05:13:57Z

LGTM. Thank you. (please self merge)

chamikaramj

Thanks.

Davor, please let me know if these changes look good to you.

chamikaramj · 2017-05-26T07:35:28Z

src/contribute/contribution-guide.md


+#### Python SDK
+
+For contributions to the Python code, you can use following commands to run unit tests locally and to check for lint errors. Once you send a pull request for review, these tests will be rerun using Jenkins. We recommend setting up a virtual environment before testing your code.


Added instructions for running tests using Maven.

asfbot · 2017-05-26T07:46:36Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Stage/513/

Jenkins built the site at commit id 41deb88 with Jekyll and staged it here. Happy reviewing.

Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again.

davorbonaci

I wonder should all things under ### Testing go to the testing page.

davorbonaci · 2017-05-26T23:59:12Z

src/contribute/contribution-guide.md


+#### Python SDK
+
+For contributions to the Python code, you can use following commands to run unit tests locally and to check for lint errors. Once you send a pull request for review, these tests will be rerun using Jenkins. We recommend setting up a virtual environment before testing your code.


Don't follow -- which are "following commands"?

Fix above: Travis CI is disabled.
Overall, I'd probably generalize and say that mvn clean verify does it all, i.e., no Java SDK/Python SDK sections at all.

chamikaramj · 2017-05-27T02:08:09Z

Did following updates.

Removed references to travis.
Removed references to "nose" since a single test can be run without that (added this command).

Given that Maven support for Python SDK is limited (does not work from a virtual environment, cannot be used to rune a single test, etc.) I think having these instructions will be useful for potential contributors to Python SDK.

asfbot · 2017-05-27T02:13:48Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Stage/517/

Jenkins built the site at commit id 8990681 with Jekyll and staged it here. Happy reviewing.

Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again.

chamikaramj · 2017-05-30T22:15:26Z

Regarding "I wonder should all things under ### Testing go to the testing page" I think it's better to keep instructions related to testing that applies to most PRs in the contributors guide (information I added) while keeping any additional information (for example Maven commands that users sometimes need) in a separate document. Davor, could you PTAL.

davorbonaci

LGTM

davorbonaci · 2017-05-30T22:17:23Z

src/contribute/contribution-guide.md


 You are now ready to start developing!

+#### [Python SDK Only] Setup a virtual environemt


Setup -> Set up?

davorbonaci · 2017-05-30T22:18:04Z

src/contribute/contribution-guide.md


+#### [Python SDK Only] Setup a virtual environemt
+
+We recommend setting up a virtual envioment for developing Python SDK. Please see instructions available at [Quickstart (Python)]({{ site.baseurl }}/get-started/quickstart-py/) for setting up a virtual environment.


at quickstart -> in quickstart?

davorbonaci · 2017-05-30T22:18:43Z

src/contribute/contribution-guide.md


+#### Python SDK
+
+For contributions to the Python code, you can use command given below to run unit tests locally. If you update any of the [cythonized](http://cython.org) files in python SDK, you must install "cython" package before running following command to properly test your code. We recommend setting up a virtual environment before testing your code.


python -> Python

chamikaramj

Thanks.

chamikaramj · 2017-05-30T23:12:14Z

src/contribute/contribution-guide.md


 You are now ready to start developing!

+#### [Python SDK Only] Setup a virtual environemt


chamikaramj · 2017-05-30T23:12:19Z

src/contribute/contribution-guide.md


+#### [Python SDK Only] Setup a virtual environemt
+
+We recommend setting up a virtual envioment for developing Python SDK. Please see instructions available at [Quickstart (Python)]({{ site.baseurl }}/get-started/quickstart-py/) for setting up a virtual environment.


chamikaramj · 2017-05-30T23:12:24Z

src/contribute/contribution-guide.md


+#### Python SDK
+
+For contributions to the Python code, you can use command given below to run unit tests locally. If you update any of the [cythonized](http://cython.org) files in python SDK, you must install "cython" package before running following command to properly test your code. We recommend setting up a virtual environment before testing your code.


…tions for Python SDK.

asfbot · 2017-05-30T23:19:41Z

Build finished.
--none--

asfbot · 2017-05-30T23:29:07Z

Build finished.

Jenkins built the site at commit id 13e2e31 with Jekyll and staged it here. Happy reviewing.

Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again.

asfbot · 2017-05-30T23:29:07Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/beam_PreCommit_Website_Stage/519/

Jenkins built the site at commit id 13e2e31 with Jekyll and staged it here. Happy reviewing.

Note that any previous site has been deleted. This staged site will be automatically deleted after its TTL expires. Push any commit to the pull request branch or re-trigger the build to get it staged again.

aaltay · 2017-05-31T15:30:53Z

LGTM. Thank you, please self merge.

chamikaramj · 2017-05-31T18:45:55Z

Thanks.

aaltay reviewed May 26, 2017

View reviewed changes

chamikaramj commented May 26, 2017

View reviewed changes

davorbonaci reviewed May 27, 2017

View reviewed changes

davorbonaci approved these changes May 30, 2017

View reviewed changes

chamikaramj force-pushed the contrib_guide_python branch from 8990681 to 26228b9 Compare May 30, 2017 23:13

chamikaramj commented May 30, 2017

View reviewed changes

Updates contribution guide to include development and testing instruc…

13e2e31

…tions for Python SDK.

chamikaramj force-pushed the contrib_guide_python branch from 26228b9 to 13e2e31 Compare May 30, 2017 23:17

asfgit merged commit 13e2e31 into apache:asf-site May 31, 2017

asfgit pushed a commit that referenced this pull request May 31, 2017

This closes #253

369b331

robertwb pushed a commit to robertwb/incubator-beam that referenced this pull request Jun 5, 2018

This closes apache/beam-site#253

90ed162

robertwb pushed a commit to robertwb/incubator-beam that referenced this pull request Jun 5, 2018

This closes apache/beam-site#253

5347042

melap pushed a commit to apache/beam that referenced this pull request Jun 20, 2018

This closes apache/beam-site#253

9b55c24


		For contributions to the Python code, you can use following commands to run unit tests locally and to check for lint errors. Once you send a pull request for review, these tests will be rerun using Jenkins. We recommend setting up a virtual environment before testing your code.

		##### Running a single test using nose


		#### Python SDK

		For contributions to the Python code, you can use following commands to run unit tests locally and to check for lint errors. Once you send a pull request for review, these tests will be rerun using Jenkins. We recommend setting up a virtual environment before testing your code.


		You are now ready to start developing!

		#### [Python SDK Only] Setup a virtual environemt


		#### [Python SDK Only] Setup a virtual environemt

		We recommend setting up a virtual envioment for developing Python SDK. Please see instructions available at [Quickstart (Python)]({{ site.baseurl }}/get-started/quickstart-py/) for setting up a virtual environment.

Conversation

chamikaramj commented May 26, 2017

Uh oh!

chamikaramj commented May 26, 2017

Uh oh!

asfbot commented May 26, 2017

Uh oh!

asfbot commented May 26, 2017

Uh oh!

aaltay left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chamikaramj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

asfbot commented May 26, 2017

Uh oh!

aaltay commented May 26, 2017

Uh oh!

chamikaramj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

asfbot commented May 26, 2017

Uh oh!

davorbonaci left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chamikaramj commented May 27, 2017

Uh oh!

asfbot commented May 27, 2017

Uh oh!

chamikaramj commented May 30, 2017

Uh oh!

davorbonaci left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chamikaramj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment