[doc] Add documentation to the python thrift client example #3652
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
csordasmarton
added
documentation 📖
whisperity
reviewed
Apr 14, 2022
Comment on lines
+23
to
+29
| wget https://github.com/Ericsson/codechecker/raw/v6.19.1/web/api/py/codechecker_api/dist/codechecker_api.tar.gz && \ | ||
| pip3 install codechecker_api.tar.gz && \ | ||
| rm -rf codechecker_api.tar.gz | ||
|
|
||
| wget https://github.com/Ericsson/codechecker/raw/v6.19.1/web/api/py/codechecker_api_shared/dist/codechecker_api_shared.tar.gz && \ | ||
| pip3 install codechecker_api_shared.tar.gz && \ | ||
| rm -rf codechecker_api_shared.tar.gz |
There was a problem hiding this comment.
Are these packages not available from PIP?
There was a problem hiding this comment.
No, these are available only in the repository as local python packages. This way open source contributors are also able to change the API easily and there is no need extra permissions for pypi and npmjs.
bruntib
requested changes
Apr 19, 2022
scripts/thrift/README.md
Outdated
| @@ -0,0 +1,41 @@ | |||
| # Python client for CodeChecker | |||
| `client.py` contains simple API requests to a CodeChecker server and it | |||
| can be a starting point how you can write your own script. | |||
There was a problem hiding this comment.
Suggested change
| can be a starting point how you can write your own script. | |
| can be a starting point for writing your own script. |
scripts/thrift/README.md
Outdated
| can be a starting point how you can write your own script. | ||
|
|
||
| Before you run this example program you have to do the following steps to | ||
| setup and environment: |
There was a problem hiding this comment.
Suggested change
| setup and environment: | |
| setup an environment: |
scripts/thrift/README.md
Outdated
| # It will download API packages for the 'v6.19.1' but you can download newer | ||
| # versions as well. | ||
| # | ||
| # WARNING: make sure that the package versions are not newer than what the |
There was a problem hiding this comment.
Suggested change
| # WARNING: make sure that the package versions are not newer than what the | |
| # WARNING: make sure that the package versions are not newer than what |
csordasmarton
force-pushed
the
thrift_client_example
branch
from
12588e0 to
0088525
Compare
bruntib
approved these changes
Apr 19, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.