Created venv builders for linux/windows and req flashers + use documentation by zkscpqm · Pull Request #38 · apache/skywalking-python

zkscpqm · 2020-07-16T10:16:53Z

Scripts folder to hold auxilliary, non-application helpers.

Initial contents:

build_requirements (win/linux): This will have a look at your virtual environment packages and flash them to a "requirements.txt" file. This file will then allow developers to set up their virtual environment easily

setup (win/linux): This will create a separate clean virtual environment for the project and only the necessary packages (outlined in requirements.txt) will be installed.

Updated the gitignore file to ignore the virtual environment

Updated README file with instructions on building and updating the requirements

…ntation

kezhenxu94

The newly-added files require a license header, you can copy one from the existing files

zkscpqm · 2020-07-16T12:20:21Z

The newly-added files require a license header, you can copy one from the existing files

Done, but as one of my files is a batch file, the comments use :: instead of # so your license checker script will probably pick that up

kezhenxu94 · 2020-07-16T12:25:49Z

The newly-added files require a license header, you can copy one from the existing files

Done, but as one of my files is a batch file, the comments use :: instead of # so your license checker script will probably pick that up

NO worries, ATM I just check 3 directories skywalking, tests, tools, so the aforementioned review comments are made manually, and it won't fail, we can add more directories to the check list if needed

kezhenxu94 · 2020-07-16T12:26:01Z

Thanks, I'll take a detailed look later

kezhenxu94 · 2020-07-16T12:35:49Z

@zkscpqm do we have a corresponding script for Mac OS?

zkscpqm · 2020-07-16T12:39:24Z

@zkscpqm do we have a corresponding script for Mac OS?

I'd like to say that the Linux scripts will work for MacOS too, but I don't have access to a Mac Environment to test. The shebang is set to #!/bin/sh and I'm not sure if that's where the binary for a Mac shell is. If you have access to a device running Mac OS, give it a go.

kezhenxu94 · 2020-07-16T12:42:06Z

@zkscpqm do we have a corresponding script for Mac OS?

I'd like to say that the Linux scripts will work for MacOS too, but I don't have access to a Mac Environment to test. The shebang is set to #!/bin/sh and I'm not sure if that's where the binary for a Mac shell is. If you have access to a device running Mac OS, give it a go.

Sure, that's what I mean because I'm trying to test it locally (with a Mac), I'll test with the Linux script then

kezhenxu94

I just record the comments in case you forget some

And mv scripts/* tools/*, (remember to update the doc as well)

kezhenxu94 · 2020-07-16T13:18:12Z

+### Steps to get an operational virtual environment:
+
+1. `git clone https://github.com/apache/skywalking-python.git`
+2. `cd skywalking-python/scripts` (*make sure you actually go into the directory since the scripts use relative paths*)


nit: I hope the script itself can tackle the paths by some extra work, that would be more friendly to the developers

kezhenxu94 · 2020-07-16T13:18:57Z

+2. `cd skywalking-python/scripts` (*make sure you actually go into the directory since the scripts use relative paths*)
+3. Run the script for your relevant OS to create a virtual environment folder in the project root (*skywalking-python/venv*) and install all the necessary requirements
+
+**Make sure that when the `python` command is executed on your workstation, the binary it references is python 3.5 or newer!**


IIRC this can be automatically determined right?

I'll have to double-check but I think you can determine either python3 or perhaps python37 but IDK about specifically python35-python38. And sometimes python3 is not implemented as an option (on my PC, writing python3 in PowerShell redirects me to the Microsoft Store :D

… linux venv bin path

kezhenxu94 · 2020-07-17T06:07:17Z

+blindspin==2.0.1
+certifi==2020.6.20
+chardet==3.0.4
+colorama==0.4.3
+crayons==0.3.1
+deprecation==2.1.0
+docker==4.2.2
+grpcio==1.30.0
+grpcio-tools==1.30.0
+idna==2.10
+packaging==20.4
+protobuf==3.12.2
+PyMySQL==0.9.3
+pyparsing==2.4.7
+pypiwin32==223
+pywin32==228
+requests==2.24.0
+six==1.15.0
+testcontainers==3.0.3
+urllib3==1.25.9
+websocket-client==0.57.0
+Werkzeug==1.0.1
+wrapt==1.12.1


Do you think that we should check in this file? I saw this is Windows-specific, and in my side, it should be Mac-specific, this file keeps changing from developer to developer

And it seems to be created automatically in the script, so don't need to check in

The point of this file is for the build script to work. If you don't have this file, the other 4 scripts are pointless. It tells them what libraries need to be installed in the virtual env so that the dev doesn't have to go file-to-file to see what they need to install

If we don't check it in, a new developer/user who is just downloading the source will not have a way to set up their venv

According to your doc, if the developers can 2. Execute the build_requirements script relevant to your OS. to generate the requirements.txt, why should we check the requirements.txt in? Other developers can also execute the same script to generate it, right?

ghost · 2020-07-17T06:47:25Z

@zkscpqm and I found a dead lock in your scripts, build_requirements_linux.sh requires venv, but venv is set up in setup_linux.sh, while setup_linux.sh install dependencies from requirements.txt which is generated in build_requirements_linux.sh, please re-consider this, or update the doc at least

ghost

LGTM, thanks for your contribution and patience very much @zkscpqm

zkscpqm added 2 commits July 16, 2020 13:09

Created venv builders for linux/windows and req flashers + use docume…

88f5df7

…ntation

forgot to add files.. see previous commit

20ce789

kezhenxu94 added chore Project chores documentation Improvements or additions to documentation labels Jul 16, 2020

kezhenxu94 added this to the 0.2.0 milestone Jul 16, 2020

kezhenxu94 reviewed Jul 16, 2020

View reviewed changes

aadd license headers to scripts

875bd6d

kezhenxu94 reviewed Jul 16, 2020

View reviewed changes

moved scripts, updated paths, changed how reqs are installed, updated…

166e89e

… linux venv bin path

kezhenxu94 reviewed Jul 17, 2020

View reviewed changes

Georgi and others added 3 commits July 18, 2020 17:26

update license checker to accomodate for shebangs and batchfile comments

ca66bc1

Fix the real checked logic

e720854

Fix code style

925ad85

kezhenxu94 approved these changes Jul 18, 2020

View reviewed changes

kezhenxu94 merged commit 82e7606 into apache:master Jul 18, 2020

Conversation

zkscpqm commented Jul 16, 2020

Uh oh!

kezhenxu94 left a comment

Choose a reason for hiding this comment

Uh oh!

zkscpqm commented Jul 16, 2020

Uh oh!

kezhenxu94 commented Jul 16, 2020

Uh oh!

kezhenxu94 commented Jul 16, 2020

Uh oh!

kezhenxu94 commented Jul 16, 2020

Uh oh!

zkscpqm commented Jul 16, 2020

Uh oh!

kezhenxu94 commented Jul 16, 2020

Uh oh!

kezhenxu94 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kezhenxu94 Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

kezhenxu94 Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

zkscpqm Jul 16, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kezhenxu94 Jul 17, 2020

Choose a reason for hiding this comment

Uh oh!

kezhenxu94 Jul 17, 2020

Choose a reason for hiding this comment

Uh oh!

zkscpqm Jul 17, 2020

Choose a reason for hiding this comment

Uh oh!

zkscpqm Jul 17, 2020

Choose a reason for hiding this comment

Uh oh!

ghost Jul 17, 2020

Choose a reason for hiding this comment

Uh oh!

ghost commented Jul 17, 2020 • edited by kezhenxu94 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kezhenxu94 left a comment •

edited

Loading

ghost commented Jul 17, 2020 •

edited by kezhenxu94

Loading