From 729415e2ff8f36ee9818a8cc454ade914b0f3247 Mon Sep 17 00:00:00 2001 From: "John T. Wodder II" Date: Sun, 18 Jun 2017 02:23:37 +0000 Subject: [PATCH 1/2] Expand the section on the "name" argument --- source/tutorials/distributing-packages.rst | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/source/tutorials/distributing-packages.rst b/source/tutorials/distributing-packages.rst index 6d26e0727..0936d8889 100644 --- a/source/tutorials/distributing-packages.rst +++ b/source/tutorials/distributing-packages.rst @@ -142,10 +142,23 @@ name name='sample', -This is the name of your project, and will determine how your project is listed -on :term:`PyPI `. For details on permitted -characters, see the :pep:`name <426#name>` -section from :pep:`426`. +This is the name of your project, determining how your project is listed on +:term:`PyPI `. Per :pep:`426`, valid project +names must: + +- Consist only of ASCII letters, digits, underscores (``_``), hyphens (``-``), + and/or periods (``.``), and +- Start & end with an ASCII letter or digit + +Comparison of project names is case insensitive and treats arbitrarily-long +runs of underscores, hyphens, and/or periods as equal. For example, if you +register a project named ``cool-stuff``, users will be able to download it or +declare a dependency on it using any of the following spellings:: + + Cool-Stuff + cool.stuff + COOL_STUFF + CoOl__-.-__sTuFF version From bdd9545c3a765dcc0854911ac6bcdb2f1a101627 Mon Sep 17 00:00:00 2001 From: "John T. Wodder II" Date: Sun, 18 Jun 2017 03:02:34 +0000 Subject: [PATCH 2/2] Refer to PEP 508 instead of 426 --- source/tutorials/distributing-packages.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/tutorials/distributing-packages.rst b/source/tutorials/distributing-packages.rst index 0936d8889..75f882a9f 100644 --- a/source/tutorials/distributing-packages.rst +++ b/source/tutorials/distributing-packages.rst @@ -143,7 +143,7 @@ name name='sample', This is the name of your project, determining how your project is listed on -:term:`PyPI `. Per :pep:`426`, valid project +:term:`PyPI `. Per :pep:`508`, valid project names must: - Consist only of ASCII letters, digits, underscores (``_``), hyphens (``-``),