Skip to content

[IMPROVEMENT] Add pytest to test requirements and document Windows test setup#1085

Open
ObaidAbdullah16 wants to merge 1 commit intoCCExtractor:masterfrom
ObaidAbdullah16:chore-add-pytest-and-windows-test-docs
Open

[IMPROVEMENT] Add pytest to test requirements and document Windows test setup#1085
ObaidAbdullah16 wants to merge 1 commit intoCCExtractor:masterfrom
ObaidAbdullah16:chore-add-pytest-and-windows-test-docs

Conversation

@ObaidAbdullah16
Copy link
Copy Markdown

PR Title: [IMPROVEMENT] Add pytest to test requirements and document Windows test setup

Please prefix your pull request with one of the following: [FEATURE] [FIX] [IMPROVEMENT].

In raising this pull request, I confirm the following (please check boxes):

  • I have read and understood the contributors guide.
  • I have checked that another pull request for this purpose does not exist.
  • I have considered, and confirmed that this submission will be valuable to others.
  • I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
  • I give this submission freely, and claim no ownership to its content.

My familiarity with the project is as follows (check one):

  • I have never used the project.
  • I have used the project briefly.
  • I have used the project extensively, but have not contributed previously.
  • I am an active contributor to the project.

Summary

This PR improves the contributor/developer experience on Windows by ensuring the test runner is available after installing test dependencies, and by documenting a working Windows (Git Bash) setup.

Changes

  • Add pytest to test-requirements.txt so python -m pytest works after installing test dependencies.
  • Add a short README section with Windows (Git Bash) commands to create a venv, install dependencies, and run the unit tests.

Motivation / Context

While setting up the project on Windows (Git Bash) inside a virtual environment, I ran:

python -m pip install -r test-requirements.txt
python -m pytest -q --maxfail=1

and got the error:

No module named pytest

This PR makes that workflow work out-of-the-box by including pytest in test-requirements.txt, and documents the Windows setup steps so new contributors don’t get blocked.

@sonarqubecloud
Copy link
Copy Markdown

@ObaidAbdullah16
Copy link
Copy Markdown
Author

Hi @canihavesomecoffee @thealphadollar — whenever you have a moment, could you please review this PR?
It adds pytest to the test requirements and updates the Windows testing setup docs. Thanks!

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