centralize repo version locations

[MoralCode]

While going through the release process with sean (b0bb3b8), the version had to be edited in a few places:

• README
• all the dockerfiles
• metadata.py

i also think we should probably specify it in pyproject.toml

But we need a way to centralize all these different ways to specify version.

i propose:

• set the dockerfiles and metadata.py (and at least other automated code things) to read from pyproject.toml (this should be a well established usecase)
• remove the version from the README (i.e. the title) and have links that point to the generic page for the latest release

[skools-here]

According to me possible approach could be:

1. Use pyproject.toml as the single source of truth for the version.

2. Update metadata.py to read the version via importlib.metadata (or similar) so it always reflects pyproject.toml.

3. For Dockerfiles, pass the version in as a build arg from CI/CD, so they don’t need to hard-code it.

4. Remove the version from the README and instead link to the latest release on GitHub as you said .

we can also add a CI check that verifies the Docker image version matches pyproject.toml.

[MoralCode]

sounds good to me! Is this something you'd be interested in working on a PR for?

[skools-here]

Yes i would love to work on this !

also while i was going through the repo i found pyproject.toml is already dynamic and getting version from metadata.py so making it canonical is not a better approach so i think a better solution could be making metadata.py as a single source of version and for docker files CI/CD reads the same version from metadata.py and injects it into the Docker build.

[MoralCode]

Oh is metadata.py a standard python thing?

[skools-here]

metadata.py itself is not a Python standard. It’s just a convention we’re using in this repo to store version.

In this project, pyproject.toml is configured with:

[tool.setuptools.dynamic]
version = { attr = "metadata.__version__" }

So setuptools looks into our metadata.py file to get the version. That makes metadata.py the canonical source of truth for the version in practice.

[prabhakaran-jm]

@MoralCode I’d like to work on this for Hacktoberfest, is anyone already working on it?

[MoralCode]

is anyone already working on it?

not that im aware of, go for it! if your PR is solid and gets merged, i'll make sure it gets the hacktoberfest-accepted label so it counts