Skip to content

Update "project" to mention pyproject.toml, not just setuptools #755

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.

Sign up for GitHub

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

Merged
pfmoore merged 1 commit into from
Jul 22, 2020
Merged

Update "project" to mention pyproject.toml, not just setuptools #755

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions source/glossary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,10 @@ Glossary
packaged into a :term:`Distribution <Distribution Package>`.

Since most projects create :term:`Distributions <Distribution Package>`
using :ref:`distutils` or :ref:`setuptools`, another practical way to
define projects currently is something that contains a :term:`setup.py`
at the root of the project src directory, where "setup.py" is the
project specification filename used by :ref:`distutils` and
:ref:`setuptools`.
using either :pep:`518` ``build-system``, :ref:`distutils` or
:ref:`setuptools`, another practical way to define projects currently
Comment on lines +105 to +106
Copy link
Member

@webknjaz webknjaz Jul 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd also swap distutils/setuptools to keep have list in the order of priority:

Suggested change
using either :pep:`518` ``build-system``, :ref:`distutils` or
:ref:`setuptools`, another practical way to define projects currently
using either :pep:`518` ``build-system``, :ref:`setuptools` or
:ref:`distutils`, another practical way to define projects currently

is something that contains a :term:`pyproject.toml`, :term:`setup.py`,
or :term:`setup.cfg` file at the root of the project source directory.
Copy link
Member

@pfmoore pfmoore Jul 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it valid to have setup.cfg without setup.py? That seems like an unrelated change, even if it is true. Maybe we should stick to just adding pyproject.toml?

Copy link
Member

@webknjaz webknjaz Jul 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pfmoore it is valid to have setup.cfg w/o setup.py if you have a modern enough setuptools version. Like in case with setuptools mentioned as a build dep in pyproject.toml.

Copy link
Member

@pfmoore pfmoore Jul 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, but in that case you need a pyproject.toml, so it seems a bit redundant. No big deal, though.


Python projects must have unique names, which are registered on
:term:`PyPI <Python Package Index (PyPI)>`. Each project will then
Expand Down Expand Up @@ -151,6 +150,11 @@ Glossary
domain name, `pypi.python.org`, in 2017. It is powered by
:ref:`warehouse`.

pyproject.toml

The tool-agnostic :term:`project` specification file.
Defined in :pep:`518`.

Release

A snapshot of a :term:`Project` at a particular point in time, denoted
Expand Down Expand Up @@ -189,8 +193,10 @@ Glossary


setup.py
setup.cfg

The project specification file for :ref:`distutils` and :ref:`setuptools`.
The project specification files for :ref:`distutils` and :ref:`setuptools`.
See also :term:`pyproject.toml`.


Source Archive
Expand Down