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

fix: inaccurate Python instructions #74

Merged
merged 1 commit into from
Aug 19, 2024

Conversation

wesleyboar
Copy link
Collaborator

@wesleyboar wesleyboar commented Aug 19, 2024

Overview

Fixed order and description of instructions for "Testing" "via Python".

Changes

  • moved pip install poetry to its own group
  • moved poetry install before poetry shell
  • changed instruction groups and descriptions

Notes

The poetry install and poetry shell commands both activate a Poetry-managed virtual environment, which is helpful to avoid dependency conflicts for users who do not use virtual environments to isolate their projects.

The poetry install installs project dependencies within the current virtual environment. The python shell allows running commands for installed dependencies e.g. mkdocs within the current virtual environment.

If poetry install has not been run yet, then poetry shell would not offer mkdocs. When mkdocs is unavailable, user response may be to install mkdocs. Installing mkdocs, while in this state, can cause different problems depending on how it is done.

  • pip install mkdocs would install latest version, not project version.
  • poetry install() would fail.1

Footnotes

  1. Because poetry is not installed within the virtual environment, because poetry is not a dependency of the project itself.

@wesleyboar wesleyboar merged commit 204f7d8 into main Aug 19, 2024
@wesleyboar wesleyboar deleted the fix/inaccurate-Python-instructions branch August 19, 2024 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant