docs: add entry to FAQ about broken package issue #531
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
tnoczyns-volue
added
the
Kind: Documentation
docs/source/faq.rst
Outdated
| .. code-block:: bash | ||
|
|
||
| # Generally we recommend to run this in virtual environment | ||
| pip install poetry-core==1.9.1 |
There was a problem hiding this comment.
I believe the "recommended" way to run pip is by doing python -m pip instead of invoking it directly.
docs/source/faq.rst
Outdated
Comment on lines
42
to
45
| This issue is fixed in Mesh Python SDK 1.11.0. All users with Mesh server | ||
| version starting from 2.15.0 should upgrade Mesh Python SDK. Users with Mesh | ||
| server version 2.14 and below need to reinstall Mesh Python SDK the following | ||
| way: |
There was a problem hiding this comment.
Suggested change
| This issue is fixed in Mesh Python SDK 1.11.0. All users with Mesh server | |
| version starting from 2.15.0 should upgrade Mesh Python SDK. Users with Mesh | |
| server version 2.14 and below need to reinstall Mesh Python SDK the following | |
| way: | |
| This issue is fixed in Mesh Python SDK 1.11.0. All users with a Mesh server | |
| version starting from 2.15.0 should upgrade the Mesh Python SDK. Users with Mesh | |
| server version 2.14 and below need to reinstall the Mesh Python SDK by running | |
| the following: |
docs/source/faq.rst
Outdated
| pip install poetry-core==1.9.1 | ||
| pip install grpcio-tools==1.66.1 | ||
| # Set your Mesh Python SDK version in the next line | ||
| pip install --no-build-isolation git+https://github.com/Volue-Public/energy-mesh-python@v1.8.0 |
There was a problem hiding this comment.
Shouldn't this be 1.11.0 instead of 1.8.0?
docs/source/faq.rst
Outdated
Comment on lines
56
to
59
| The reason is that we need poetry-core version below 2.0.0. To do this we need | ||
| to install Mesh Python SDK with `--no-build-isolation` flag. This flag requires | ||
| all the build dependencies to be already installed on the system. That is why | ||
| we install poetry-core and grpcio-tools before installing Mesh Python SDK. |
There was a problem hiding this comment.
Suggested change
| The reason is that we need poetry-core version below 2.0.0. To do this we need | |
| to install Mesh Python SDK with `--no-build-isolation` flag. This flag requires | |
| all the build dependencies to be already installed on the system. That is why | |
| we install poetry-core and grpcio-tools before installing Mesh Python SDK. | |
| The reason for this is that we need poetry-core to be older than version 2.0.0. Here we use the `--no-build-isolation` flag to prevent pip from automatically installing any dependencies, and we install them manually instead. |
|
Review suggestions applied in 2373e66. @martingalvan-volue could you re-review? |
martingalvan-volue
approved these changes
Jan 8, 2025
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.
Description of ways to address #526 issue.