Skip to content

Commit 6db49ef

Browse files
Added links to build tools
1 parent 892d045 commit 6db49ef

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

source/single_source_version.rst

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@ Single-sourcing the Project Version
1010
One of the challenges in building packages is that the version string can be required in multiple places.
1111

1212
* It needs to be specified when building the package (e.g. in :file:`pyproject.toml`)
13-
- That will assure that it is properly assigned in the distribution file name, and in teh installed package.
13+
- That will assure that it is properly assigned in the distribution file name, and in the installed package.
1414

1515
* Some projects require that there be a version string available as an attribute in the importable module, e.g::
1616

1717
import a_package
1818
print(a_package.__version__)
19+
1920
* In the metadata of the artifacts for each of the packaging ecosystems
2021

2122
While different projects have different needs, it's important to make sure that there is a single source of truth for the version number.
@@ -36,17 +37,15 @@ If the version string is not in the source, it can be extracted at runtime with
3637

3738
Consult your build system documentation for how to implement your preferred method.
3839

39-
Put links in to build system docs?
40-
-- I have no idea which are currently robust and maintained -- do we want to get into seeming endorsing particular tools in this doc?
41-
40+
Here are the common ones:
4241

43-
* setuptools:
42+
* `Hatch <https://hatch.pypa.io/1.9/version/>`_
4443

45-
* hatch:
44+
* `Setuptools <https://setuptools.pypa.io/en/latest/userguide/distribution.html#specifying-your-project-s-version>`_
4645

47-
* poetry:
46+
- `setuptools_scm <https://setuptools-scm.readthedocs.io/en/latest/>`_
4847

49-
* PyBuilder:
48+
* `Flit <https://flit.pypa.io/en/stable/>`_
5049

51-
* Others?
50+
* `PDM <https://pdm-project.org/en/latest/reference/pep621/#__tabbed_1_2>`_
5251

0 commit comments

Comments
 (0)