source/guides/distributing-packages-using-setuptools.rst probably needs an update, as it claims sampleproject should include files setup.py and setup.cfg (and maybe others)

[kirisakow]

What's wrong?

The guide claims sampleproject should include files setup.py and setup.cfg (maybe others too), while sampleproject does no longer include those files since it has adopted PEP 621 metadata (see pypa/sampleproject#166). Also, matter discussed earlier today with dmtucker.

Where?

Configuring your project

Initial files

setup.py

The most important file is setup.py which exists at the root of your project directory. For an example, see the setup.py in the PyPA sample project.

setup.py serves two primary functions:

1. It’s the file where various aspects of your project are configured. The primary feature of setup.py is that it contains a global setup() function. The keyword arguments to this function are how specific details of your project are defined. The most relevant arguments are explained in the section below.

2. It’s the command line interface for running various commands that relate to packaging tasks. To get a listing of available commands, run python setup.py --help-commands.

setup.cfg

setup.cfg is an ini file that contains option defaults for setup.py commands. For an example, see the setup.cfg in the PyPA sample project.

[bhrutledge]

Thanks for the report. I think this duplicates:

• Contradictions/Inconsistencies between packaging tutorial and guide #887
• Links to setuptools documentation need to be updated #792
• Outdated references to (removed) setup.py and setup.cfg in PyPA’s sampleproject #1184