Skip to content
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

docs: add entry to FAQ about broken package issue #531

Merged
merged 2 commits into from
Jan 8, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/source/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,34 @@ I get a SSL_ERROR_SSL. What am I doing wrong?
If your server is set up to not use TLS and you try to connect using a secure connection you will get this error. Either change the server to use TLS (Configuration.Network.GRPC.EnableTLS(true)) or change you client code to connect without a secure connection.


I get an ImportError: cannot import name 'auth_pb2' from 'volue.mesh.proto.auth.v1alpha'.
*****************************************************************************************

When trying to use the Mesh Python SDK you might get an error like this.
All Mesh Python SDK versions up to 1.10.0 (inclusive) are affected by this
issue.

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:

.. code-block:: bash

# Generally we recommend to run this in virtual environment
python -m pip install poetry-core==1.9.1
python -m pip install grpcio-tools==1.66.1
# Replace <YOUR_MESH_PYTHON_SDK_VERSION_HERE> with the version you want to install
python -m pip install --no-build-isolation git+https://github.com/Volue-Public/energy-mesh-python@<YOUR_MESH_PYTHON_SDK_VERSION_HERE>


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 in an isolated build environment, and we install
them manually instead.

See :issue:`526` for more information.

I get a RESOURCE_EXHAUSTED gRPC error.
**************************************

Expand Down
Loading