pypa / pypa/packaging.python.org
Provide some guidance on specifying test dependencies
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 4
Description
The packaging guide could use a brief blurb providing guidance on how to specify test dependencies for your project.
Some background:
- There is this question on Stack Overflow on how to use the
tests_requireoption ofsetuptools.setup(). The question has 25K views. - The setuptools docs for
tests_requireexplain that the option is used for thetestcommand, but also that thetestcommand was deprecated in version 41.5.0.
Would it make sense to add something to the setuptools guide on specifying test dependencies, and specifically on whether or not to use tests_require?
What would the guidance be?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the setuptools guide and the linked setuptools documentation for tests_require, then review the Stack Overflow question for the recurring user need. Decide what current guidance the packaging guide should give about test dependencies and the deprecated test command; done means a brief, accurate section is added to the guide.
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
- 35/100