Skip to content

Commit d267389

Browse files
committed
Add draft documentation (incomplete)
1 parent bf15ea9 commit d267389

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

CHANGELOG.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
v3.4.0
2+
======
3+
4+
* fix #181 - add support for projects built under setuptools declarative config
5+
by way of the setuptools.finalize_distribution_options hook in Setuptools 42.
6+
17
* fix #305 - ensure the git file finder closes filedescriptors even when errors happen
28

39
v3.3.3

README.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,29 @@ It also handles file finders for the supported SCMs.
1313
.. image:: https://tidelift.com/badges/github/pypa/setuptools_scm
1414
:target: https://tidelift.com/subscription/pkg/pypi-setuptools_scm?utm_source=pypi-setuptools_scm&utm_medium=readme
1515

16+
``pyproject.toml`` usage
17+
------------------------
18+
19+
The preferred way to configure ``setuptools_scm`` is to author
20+
settings in a ``tool.setuptools_scm`` section of ``pyproject.toml``.
21+
22+
This feature requires Setuptools 42 or later, released in Nov, 2019.
23+
If your project needs to support build from sdist on older versions
24+
of Setuptools, you will need to also implement the ``setup.py usage``
25+
for those legacy environments.
26+
27+
First, ensure that ``setuptools_scm`` is present during the project's
28+
built step by specifying it as one of the build requirements.
29+
30+
.. code:: ini
31+
32+
# pyproject.toml
33+
[build-system]
34+
requires = ["setuptools>=42", "wheel", "setuptools_scm>=3.4"]
35+
36+
37+
To enable version inference, add this section to your pyproject.toml
38+
1639
``setup.py`` usage
1740
------------------
1841

0 commit comments

Comments
 (0)