Ad-hoc version/local scheme substitution

[webknjaz]

It is known that PyPI doesn't accept local version identifiers (#322)
so when uploading non-tagged versions to TestPyPI, I need to do something
like echo 'local_scheme = "no-local-version"' >> pyproject.toml which
effectively marks the tree dirty influencing the generated version.
I also want to keep the defaults in all other cases (everything except
for non-tagged commits in CI/CD).
Would it be reasonable to support some sort of an env var based solution
for overriding a local version scheme w/o touching the file system?

[RonnyPfannschmidt]

this one needs some thought wrt howto integrate it sanely

[webknjaz]

I guess the immediate workaround would be git update-index --assume-unchanged pyproject.toml in CI.

[RonnyPfannschmidt]

@webknjaz im considering adding a SETUPTOOLS_SCM_CONFIG_OVERRIDES_FOR_{package-name.capitalize().replace("-","_")] env var containing json

any opinion?

[webknjaz]

That's exactly what I was thinking about.

[bilke]

By using the (deprecated) setup.py-approach you can implement this via environment variables, e.g.:

# setuptools_scm config local_scheme via env var SETUPTOOLS_SCM_LOCAL_SCHEME:
scm_local_scheme = "node-and-date"
if "SETUPTOOLS_SCM_LOCAL_SCHEME" in os.environ:
    local_scheme_values = [
        "node-and-date",
        "node-and-timestamp",
        "dirty-tag",
        "no-local-version",
    ]
    if os.environ["SETUPTOOLS_SCM_LOCAL_SCHEME"] in local_scheme_values:
        scm_local_scheme = os.environ["SETUPTOOLS_SCM_LOCAL_SCHEME"]
    #else:
         # print some warning

setup(
    ...
    use_scm_version={
        "local_scheme": scm_local_scheme,
    },
)

[webknjaz]

By using the (deprecated) setup.py

FTR setup.py is not deprecated. Calling it directly is.

[webknjaz]

UPD:

echo 'local_scheme = "no-local-version"' >> pyproject.toml

Looks like this stopped working with modern setuptools versions :(

Exactly what #686 (comment) says. I wonder why nobody filed an issue for this...

UPD 2: Nevermind, it was a combination of newer setuptools (v69) and older setuptools-scm (v7). Upgrading it to v8 fixed the problem.