Skip to content

Commit

Permalink
Expand the section on the "name" argument (#329)
Browse files Browse the repository at this point in the history
Als updates reference to be to PEP 508 instead of 426
  • Loading branch information
jwodder authored and ncoghlan committed Jun 18, 2017
1 parent d2a8ccf commit 14580ab
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions source/tutorials/distributing-packages.rst
Expand Up @@ -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 <Python Package Index (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 <Python Package Index (PyPI)>`. Per :pep:`508`, 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
Expand Down

0 comments on commit 14580ab

Please sign in to comment.