#1154 Python: Add a warning about git tarballs and setuptools_scm
Merged by churchyard. Opened by churchyard.
churchyard/packaging-committee setuptools_scm  into  master

Download 1154.patch

I'd appreciate it if somebody could review the language and understandability of this.

Other than that, I don't think this requires a vote, it is not a new rule, just a warning about the status quo.

LGTM, though I have suggestions that might improve clarity of the text a bit.
Feel free to take the parts you like (if any) and ignore the ones you don't. :)


WARNING: Some Python packages use metadata from git
(or a similar version control system)
to construct their version string,
for example via https://pypi.org/project/setuptools-scm/[setuptools_scm].
When publishing a package to PyPI,
this version metadata is usually stored and included in a file,
so the version control system (VCS?) history is no longer needed
to construct the correct version string.
However, when using tarballs from a git forge directly,
this version information is missing
and must be manually provided by the packager.
For example, the SETUPTOOLS_SCM_PRETEND_VERSION environment variable can be set
to the desired value in the +%generate_buildrequires+ and +%build+ scripts in the spec file
for packages that use setuptools_scm for this purpose.

Amended. WDYT?

rebased onto 40f821a52a6fbda0b67ab6460cc644e44250f07e

:thumbsup: LGTM

Pull-Request has been merged by churchyard

Metadata