Skip to content

Clarify the packaging tutorial's importable-package scope - #2147

Open
harshitethic wants to merge 1 commit into
pypa:mainfrom
harshitethic:docs/614-clarify-packaging-tutorial-scope
Open

harshitethic wants to merge 1 commit into
pypa:mainfrom
harshitethic:docs/614-clarify-packaging-tutorial-scope

Conversation

@harshitethic

@harshitethic harshitethic commented Sep 29, 2026 •

Copy link
Copy Markdown

Addresses #614.

Summary

  • state that the tutorial example is an importable Python package
  • point command-line application authors to the dedicated command-line tools guidance
  • explain that an empty __init__.py does not automatically re-export add_one
  • show the correct import form and clarify that re-exporting names is an API-design choice

Validation

  • documentation-only change
  • branch is based on current upstream main

📚 Documentation preview 📚: https://python-packaging-user-guide--2147.org.readthedocs.build/en/2147/

@merwok

merwok commented Sep 30, 2026

Copy link
Copy Markdown
Contributor

I feel that more little bits of this doc could be improved. I also wonder why the tutorial does not start with a single module before moving on to a package example. I could see people coming from other languages with namespaces (like npm or even github tight coupling like go) being unsure about what is happening here and confused between project directory and import package name!

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.

2 participants