Skip to content

Commit 33c6f04

Browse files
committed
README: Add references to pyproject.toml
This is required if you wish to ensure a given version of setuptools is present. Signed-off-by: Stephen Finucane <[email protected]>
1 parent 00352a2 commit 33c6f04

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,23 @@ However, ``use_scm_version`` must still be placed in ``setup.py``. For example:
9797
setuptools_scm
9898
...
9999
100-
If using this, you must neither the ``[metadata] version`` option nor the
101-
``[egg_info]`` section are not defined.
100+
.. important::
101+
102+
Ensure neither the ``[metadata] version`` option nor the ``[egg_info]``
103+
section are not defined, as these will interfere with ``setuptools_scm``.
104+
105+
You may also need to define a ``pyproject.toml`` file (`PEP-0518
106+
<https://www.python.org/dev/peps/pep-0518>`_) to ensure you have the required
107+
version of ``setuptools``:
108+
109+
.. code:: ini
110+
111+
# pyproject.toml
112+
[build-system]
113+
requires = ["setuptools>=30.3.0", "wheel"]
114+
115+
For more information, refer to the `setuptools issue #1002
116+
<https://github.com/pypa/setuptools/issues/1002>`_.
102117

103118

104119
Programmatic usage

0 commit comments

Comments
 (0)