pypa / pypa/packaging.python.org
Clarify that Packaging Tutorial is for importable modules
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 4
Description
Following-up from a discussion with @ncoghlan at the PyCon 2019 packaging sprint, re: https://packaging.python.org/tutorials/packaging-projects/
I have a simple executable script that I run on the command line as python my_utility.py. I'd rather run it as my_utility. The tutorial doesn't cover entry_points. I don't necessarily think it should, but I think it'd be helpful to make that a clear distinction, possibly with links to relevant next steps.
entry_points is discussed in the packaging and distributing guide, and used in the sample project.
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 Packaging Tutorial at https://packaging.python.org/tutorials/packaging-projects/ and compare its scope with the linked entry-points guide and sample project. Clarify that the tutorial targets importable modules, then add links or next-step guidance for executable scripts; the tutorial should make this distinction explicit.
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