pypa / pypa/setuptools

[Docs] Clarify expected interface for running distutils.commands

Open
#3,442 9 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation Needs Triage
Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Description

Summary

I am the maintainer of py2exe and I am in the process of migrating it from distutils to setuptools. While reading the new documentation, I found out this extremely useful page that carefully explains how to add a new command and even new keywords for the setup() method, effectively mimicking what has been possible up to now with distutils. If this API is supposed to be actively supported in the future, changes on py2exe would most likely be relatively minimal.

However, at the end of the very same page, under Final Remarks there is this sentence:

Directly calling python setup.py ... is considered a deprecated practice. You should not add new commands to setuptools expecting them to be run via this interface.

which seems to contradict the point of the whole page. I think I am missing something here: what is then the expected way to run a distutils.commands entry point? Do you plan to discontinue the python setup.py ... command interface?

Thanks for this clarification and for maintaining setuptools.

OS / Environment

No response

Additional Information

The linked page should clarify what is the command line interface that should be used to run commands added to setuptools via the supported distutils.commands entry point.

Code of Conduct
  • I agree to follow the PSF Code of Conduct

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked setuptools extension documentation, especially the command example and Final Remarks. Review the unresolved question about the supported interface for running distutils.commands entry points, then update the page so the expected command-line workflow and status of python setup.py are explicit.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.