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 Troubleshooting **Poe the Poet** installation section #13

Merged
merged 1 commit into from
Nov 1, 2024
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
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,43 @@ poetry run pre-commit install

We run all the scripts using [Poe the Poet](https://poethepoet.natn.io/index.html) as our task manager.

<details>
<summary>Troubleshooting **Poe the Poet** installation. Errors while running `poetry self add 'poethepoet[poetry_plugin]'` </summary>
If you get a `ChefBuildError` error while running `poetry self add 'poethepoet[poetry_plugin]'` (or any other error), the error is likely related to Poetry's plugin installation process.

Here are a few potential solutions:

1. First, try installing poethepoet without the Poetry plugin functionality:
```bash
poetry add poethepoet
```

2. If that doesn't work, you can try installing it globally using pip:
```bash
pip install poethepoet
```

3. If you're still having issues, you can try updating Poetry first and then installing poethepoet:
```bash
poetry self update
poetry add poethepoet
```

4. As a last resort, you could try uninstalling and reinstalling Poetry completely:
```bash
# Uninstall Poetry
curl -sSL https://install.python-poetry.org | python3 - --uninstall

# Reinstall Poetry
curl -sSL https://install.python-poetry.org | python3 -

# Then try adding poethepoet again
poetry add poethepoet
```

Also, note that even without `poethepoet`, you can still run the project's commands directly using Poetry's run command with slightly different syntax. For example, instead of `poetry poe local-infrastructure-up`, you could use the underlying command directly, which you can find in the `pyproject.toml` file.
</details>

To activate the environment created by Poetry, run:
```shell
poetry shell
Expand Down
Loading