Skip to content

fix: add pytest-cases note to setup instructions (#1029)te#1031

Open
sallykinyua wants to merge 3 commits intomalariagen:masterfrom
sallykinyua:patch-1
Open

fix: add pytest-cases note to setup instructions (#1029)te#1031
sallykinyua wants to merge 3 commits intomalariagen:masterfrom
sallykinyua:patch-1

Conversation

@sallykinyua
Copy link
Copy Markdown

@sallykinyua sallykinyua commented Mar 3, 2026

Updated CONTRIBUTING.md setup instructions to fix the ModuleNotFoundError: No module named 'pytest_cases' error encountered by new contributors on a fresh clone.

New contributors following the setup instructions were hitting a confusingModuleNotFoundError with no guidance on how to resolve it. Using poetry install --extras dev installs all development dependencies including pytest-cases in one command.

Replaced poetry install with poetry install --extras dev
Added a Note clarifying why --extras dev is needed
Added a Python version note after Prerequisites
Added a Tip in the Testing section for contributors working
on new features like the NL interface
Documentation only — no functional code was changed.

Fixes #1029

New contributors on a fresh clone encounter a confusing 
ModuleNotFoundError: No module named 'pytest_cases' when 
running tests, with no guidance on how to resolve it.

Added a note to CONTRIBUTING.md clarifying that pytest-cases 
is required and how to install it explicitly.
@jwgarber
Copy link
Copy Markdown

jwgarber commented Mar 4, 2026

The best way to fix this is to use poetry install --extras dev, that will install all the pytest dependencies.

@sallykinyua
Copy link
Copy Markdown
Author

Thank you @jwgarber let me look into that and change

…n#1029)

Updated installation instructions and notes for dependencies in CONTRIBUTING.md.
Copy link
Copy Markdown
Author

@sallykinyua sallykinyua left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated CONTRIBUTING.md setup instructions to fix the ModuleNotFoundError: No module named 'pytest_cases' error encountered by new contributors on a fresh clone.

New contributors following the setup instructions were hitting a confusingModuleNotFoundError with no guidance on how to resolve it. Using poetry install --extras dev installs all development dependencies including pytest-cases in one command.

  • Replaced poetry install with poetry install --extras dev
  • Added a Note clarifying why --extras dev is needed
  • Added a Python version note after Prerequisites
  • Added a Tip in the Testing section for contributors working
    on new features like the NL interface

Documentation only — no functional code was changed.

Fixes #1029

@sallykinyua
Copy link
Copy Markdown
Author

Hi @jonbrenas I would like a review

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.

Setup instructions in CONTRIBUTING.md fail with ModuleNotFoundError: pytest_cases on fresh clone

2 participants