classification
Title: Naming conventions and guidelines for packages and namespace packages
Type: enhancement Stage:
Components: Documentation Versions:
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: alexis, benoitbryon, docs@python, eric.araujo
Priority: normal Keywords: patch

Created on 2012-05-24 12:42 by benoitbryon, last changed 2012-06-27 08:29 by benoitbryon.

Files
File name Uploaded Description Edit
4b311ce6624b.diff eric.araujo, 2012-05-25 05:33 review
Repositories containing patches
https://bitbucket.org/benoitbryon/cpython#doc-package-names
Messages (6)
msg161502 - (view) Author: Benoît Bryon (benoitbryon) Date: 2012-05-24 12:42
Scope:

* Python documentation lacks conventions, or at least guidelines,
  to choose a name for a package.

* Python has tools to create and distribute packages.
  Not covered by this issue.

* Python has tools to create namespace packages.
  Not covered by this issue.

* Python has conventions about "syntax" of module names in PEP 8.
  Not covered by this issue.

Goal: add guidelines+conventions about package names in Doc/packaging/

Discussion started at http://mail.python.org/pipermail/distutils-sig/2012-May/018551.html

Jim Fulton said in http://mail.python.org/pipermail/distutils-sig/2012-May/018553.html:

> +1 for an official document (or addition to an existinhg document)
     providing a rational for namespace packages and their naming

Here is a ticket where proposals can be referenced.

Contributions can be pushed on the "doc-package-naming-conventions" branch of https://bitbucket.org/benoitbryon/cpython
msg161504 - (view) Author: Benoît Bryon (benoitbryon) Date: 2012-05-24 13:10
Use branch ""doc-package-names" (not only conventions) instead.
msg161505 - (view) Author: Benoît Bryon (benoitbryon) Date: 2012-05-24 13:16
See Martin Aspeli's article at http://www.martinaspeli.net/articles/the-naming-of-things-package-names-and-namespaces
msg161549 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2012-05-25 05:32
Thanks for the report.  You are confusing Python packages and the distributable things that are also called packages (not by most of the distutils docs though where they are named distributions).  PEP 8 covers conventions for naming modules (including packages); PEP 345 defines project names (in a very open way though).  I am not sure the docs need to do more; I will reply to the distutils-sig messages and read the link you provided.
msg161553 - (view) Author: Benoît Bryon (benoitbryon) Date: 2012-05-25 05:59
I didn't provided the patch because the work is still at early stage. I planned to provide a patch when the development branch is quite mature.
I created the issue early so that other people can contribute.

But I maybe I'd better read PEP 1 again... because it looks like a PEP (which may lead back to this ticket when it's time for implementation).

I'm to post a proposal to python-list or python-ideas mailing lists.
msg164128 - (view) Author: Benoît Bryon (benoitbryon) Date: 2012-06-27 08:29
The proposal has been added to PEPs repository as PEP 423 :
http://hg.python.org/peps/rev/52767ab7e140

Review is about to be started at python-dev@python.org.

To adapt the scope of this issue, in cpython documentation, I am to:

* remove the Doc/packaging/packagenames.rst document
* replace it by references to PEP 423

Obviously, this work requires that PEP 423 is accepted.
History
Date User Action Args
2012-06-27 08:29:55benoitbryonsetmessages: + msg164128
2012-05-31 09:36:37alexissetnosy: + alexis
2012-05-25 05:59:52benoitbryonsetmessages: + msg161553
2012-05-25 05:33:10eric.araujosetfiles: + 4b311ce6624b.diff
keywords: + patch
2012-05-25 05:32:26eric.araujosetnosy: + eric.araujo
messages: + msg161549
2012-05-24 13:16:16benoitbryonsetmessages: + msg161505
2012-05-24 13:10:57benoitbryonsetmessages: + msg161504
2012-05-24 12:42:06benoitbryoncreate