Add README.

Lest we forget what the hell this was for six months down the line.
This commit is contained in:
kat
2026-08-08 18:34:21 +10:00
parent 0ea4c6ad84
commit 8d0355a493
2 changed files with 33 additions and 0 deletions
+32
View File
@@ -0,0 +1,32 @@
`setuptools-scm-stub`
=====================
Stub for [`setuptools-scm`] that uses a hardcoded version—the value of
`$SETUPTOOLS_SCM_PRETEND_VERSION`—instead.
[`setuptools-scm`]: https://pypi.org/project/setuptools-scm
Why?
----
`setuptools-scm`'s raison d'être is to extract the version from a `.git`/`.hg`
subdirectory, which is incompatible with reproducible builds as those
directories are not reproducible in the slightest, and is hence usually removed.
It does, however, let you override the version with a hardcoded value too,
albeit it's implementation thereof is rather poor.
Ergo, `setuptools-scm` sans the “scm” gives you an over-engineered package that
mutates a singular variable: one that releases much too frequently, and of—to
put it mildly—questionable quality; this stub's purpose is simply to reduce the
maintenance burden on packagers who have to deal with `setuptools-scm` for zero
reason.
How?
----
Simply install this package to the virtual environment in question, set the
`SETUPTOOLS_SCM_PRETEND_VERSION` environment variable to the version you want to
use during the build, and it should just work. This package does, however,
assume that you're using a single virtual environment to build a single package,
as it does not support setting the hardcoded version for a specific named
package.
+1
View File
@@ -20,6 +20,7 @@ classifiers = [
] ]
license-files = ["LICENSE-CC0", "LICENSE-APACHE"] license-files = ["LICENSE-CC0", "LICENSE-APACHE"]
readme = "README.md"
requires-python = ">=3.11" requires-python = ">=3.11"
dependencies = ["setuptools>=45"] dependencies = ["setuptools>=45"]