Skip to content

Consistency of documentation of what version of setuptools is required #921

@ksunden

Description

@ksunden

Currently there are references to the required version being:

At various places in the docs/code.

Additionally, there is a comment that states:

https://github.com/pypa/setuptools_scm/blob/ceca2352f09ed22f825f45a392cca5aff83c6aff/docs/index.md?plain=1#L16-L17

However, the pyproject.toml does include setuptools as a runtime dependency, but does so with no pin, allowing broken environments to exist:

https://github.com/pypa/setuptools_scm/blob/ceca2352f09ed22f825f45a392cca5aff83c6aff/pyproject.toml#L48

Making these sources consistent would be appreciated, as it is rather hard to tell what I actually need to do as a user.

In my case, build isolation was getting most recent setuptools but then installing into an env that had older setuptools, and we have setuptools_scm as an optional dependency to get updated version numbers for editable installs. But because nothing pinned a version for runtime, it warned (which turned into errors in the test suite).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions