Qiskit / qiskit-fermions / 29262826814

98%

push

github

feat: add version information to the package (#178)

The package previously had no version information: `pyproject.toml` hard-coded
`version = "0.0.0"` and there was no `qiskit_fermions.__version__`.

Introduce a committed `VERSION.txt` as the single source of truth for the
release number, following the same approach as Qiskit itself. Keeping the
version in a committed file (rather than deriving it purely from git tags) means
a source tarball is self-contained and needs no git history to know its version.
A `version.py` reads the file and, when importing from a git checkout whose HEAD
is not tagged, appends a PEP 440 `+<sha7>` local version identifier so editable
installs report the exact commit they were built from.

Because the package lives at `<repo>/python/qiskit_fermions/` rather than
`<repo>/qiskit/`, the repo-root detection walks two directories up instead of
the one Qiskit's own `version.py` assumes.

`pyproject.toml` now derives the version dynamically from
`qiskit_fermions.version.__version__` and ships `VERSION.txt` as package data.

The Cargo workspace version is kept in lockstep in SemVer form
(`0.1.0.dev0` <-> `0.1.0-dev0`). Cargo cannot derive its version from git, so a
new `make version-bump VERSION=<pep440>` target (backed by
`tools/set_version.py`) writes both manifests consistently and refreshes
`Cargo.lock`, to be used for the release / open-development ritual.

`version.py` shells out to git and is exercised only during packaging, so it is
omitted from coverage measurement rather than covered by the test suite.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

1 of 1 new or added line in 1 file covered. (100.0%)

7682 of 7856 relevant lines covered (97.79%)

161.8 hits per line