Skip to content

Commit ba74e98

Browse files
Added troubleshooting guide to docs
Signed-off-by: Shay Nehmad <[email protected]>
1 parent 7c5ee47 commit ba74e98

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/troubleshooting.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
===============
2+
Troubleshooting
3+
===============
4+
5+
This troubleshooting guide includes common issues users have faced and tips for dealing with them.
6+
7+
If you don't find answers to your problems here, be sure to check out ``betterproto``'s `Slack`!
8+
9+
Upgrading betterproto in a poetry environment
10+
=============================================
11+
12+
It seems like in some situations, installing and then updating ``betterproto`` in ``poetry`` environments doesn't work. If, after updating ``betterproto``, you're not getting the new features you wanted, in might be because of the current virtual environment ``poetry`` has created. While there's probably a "surgical" fix, we've found that removing the venv and re-installing it works.
13+
14+
To do that, run ``poetry env info`` to see the venv path:
15+
16+
```sh
17+
❯ poetry env info
18+
19+
Virtualenv
20+
Python: 3.8.7
21+
Implementation: CPython
22+
Path: /home/username/.cache/pypoetry/virtualenvs/project-name-random-py3.8 # <-- THIS PATH
23+
Valid: True
24+
```
25+
26+
Then just ``rm -rf`` that path to delete the venv, and re-create the env using `poetry shell` and `poetry install`.
27+
28+
.. _Slack: https://join.slack.com/t/betterproto/shared_invite/zt-f0n0uolx-iN8gBNrkPxtKHTLpG3o1OQ
29+

0 commit comments

Comments
 (0)