twoscoops / twoscoops/Creating-and-Distributing-Python-Packages

Improve explanation for running tests

Open
#13 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
8
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## Location within the Course

* Section: 4
* Lesson: 1
* Language: English

## Description

In the section "Run the Test Suite With setup.py", I found the instructions a bit confusing. It says: "run the test suite in a temporary testing environment, installing whatever is needed from test_requirements into that environment:". It wasn't immediately obvious to me that we should be in our projects/packaging/ folder, but in a new virtual environment where we `pip install` what is in the `test_requirements` list.

Perhaps a bit more explanation, plus a description of what else might be in the `test_requirements` list, if anything. Or if there are cases where we might want to add things to the list, if that applies at all. Since it's a list, seems like there might be multiple things in it.

Also, in the "Optional: Run the Test Suite Without setup.py", be more explicit that we are installing pytest in our original project package environment rather than a new test environment.

Contributor guide

Open the contributing guide

Research direction

Start with Section 4, Lesson 1, especially “Run the Test Suite With setup.py” and “Optional: Run the Test Suite Without setup.py.” Clarify the working directory, virtual-environment distinction, pytest installation, and the purpose and possible contents of test_requirements. Done means readers can distinguish both workflows without ambiguity.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.