Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Expand the section on the "name" argument #329

Merged
merged 2 commits into from Jun 18, 2017
Merged

Expand the section on the "name" argument #329

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
729415e
Expand the section on the "name" argument
jwodder Jun 18, 2017
bdd9545
Refer to PEP 508 instead of 426
jwodder Jun 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 17 additions & 4 deletions source/tutorials/distributing-packages.rst
View file
Open in desktop
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