Git versioning with setuptools in pyproject.toml

Question

I'm trying to build a few packages with an automatic versioning set by setuptools-git-versioning. Unfortunately, even following the documentation and the very few resources online, I can't manage to make this versioning work.

pyproject.toml:

[build-system]
requires = ["setuptools>=42", "wheel", "setuptools-git-versioning"]
build-backend = "setuptools.build_meta"

[tool.setuptools-git-versioning]
enabled = true

...

[project]
version = "1.0"
...

According to documentation, the enabled flag should suffice for setuptools to get the tag-based version and set it as the version of the package, yet when building the package, the version prompted when running python3 -m pip list or conda list corresponds to the hard-coded value of version in the project section of pyproject.toml.

What am I missing/doing wrong?

tripleee · Accepted Answer · 2024-02-04 08:54:01Z

14

According to the PyPa documentation when version is defined statically it can't be changed by a tool (i.e. setuptools-git-versioning in this case). The other option is to use dynamic which...

Dynamic metadata is listed via the dynamic field (defined later in this specification) and represents metadata that a tool will later provide.

So removing the static version = "1.0" and adding dynamic = ["version"] to the [project] should work.

edited Feb 4, 2024 at 8:54

tripleee

192k37 gold badges317 silver badges366 bronze badges

answered Jul 20, 2022 at 21:10

Marmstrong

1,7967 gold badges30 silver badges56 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Raven Over a year ago

I just incorporated this into my own project. Thanks for your answer

johnson · Accepted Answer · 2024-08-01 15:32:41Z

2

From the docs of setuptools-scm.

Add the following to your pyproject.toml to infer the version from git (or hg):

[build-system]
requires = ["setuptools>=64", "setuptools_scm>=8"]
build-backend = "setuptools.build_meta"

[project]
name = "example"
# Important: Remove any existing version declaration
# version = "0.0.1"
dynamic = ["version"]
# more missing

[tool.setuptools_scm]

answered Aug 1, 2024 at 15:32

johnson

4,4854 gold badges35 silver badges40 bronze badges

Collectives™ on Stack Overflow

Git versioning with setuptools in pyproject.toml

2 Answers 2

1 Comment

Comments

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Related